com.aspose.email

Class MboxrdStorageReader

java.lang.Object

com.aspose.email.MboxStorageReader

com.aspose.email.MboxrdStorageReader

All Implemented Interfaces:

com.aspose.ms.System.IDisposable, Closeable, AutoCloseable

public final class MboxrdStorageReader
extends MboxStorageReader

Represents mboxrd format storage reader, this format is being used by Thunderbird and other mail clients.

Field Summary

Fields inherited from class com.aspose.email.MboxStorageReader

EmptyFromMarkerCR, EmptyFromMarkerCRLF, EmptyFromMarkerLF, FromMarker, MboxoMarker, preferredTextEncoding

Constructor Summary

Constructors

Constructor and Description
MboxrdStorageReader(InputStream stream, boolean leaveOpen) Deprecated. This ctor is obsolete and will be removed soon. Please use ctor with MboxLoadOptions
MboxrdStorageReader(InputStream stream, MboxLoadOptions options) Initializes a new instance of the MboxrdStorageReader class.
MboxrdStorageReader(com.aspose.ms.System.IO.Stream stream, boolean leaveOpen) Deprecated. This ctor is obsolete and will be removed soon. Please use ctor with MboxLoadOptions
MboxrdStorageReader(com.aspose.ms.System.IO.Stream stream, MboxLoadOptions options) Initializes a new instance of the MboxrdStorageReader class.
MboxrdStorageReader(String fileName, boolean leaveOpen) Deprecated. This ctor is obsolete and will be removed soon. Please use ctor with MboxLoadOptions
MboxrdStorageReader(String fileName, MboxLoadOptions options) Initializes a new instance of the MboxrdStorageReader class.

Method Summary

Methods

Modifier and Type	Method and Description
int	getTotalItemsCount() Returns the number of messages in a storage.
MailMessage	readNextMessage() Reads the next message from underlying storage stream.
MailMessage	readNextMessage(String[] fromMarker) Reads the next message from underlying storage stream.

Methods inherited from class com.aspose.email.MboxStorageReader

byteArrayStartsFromMarker, close, createReader, createReader, createReader, createReader, createReader, createReader, dispose, dispose, enumerateMessages, getCurrentDataSize, readLine, setCurrentDataSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MboxrdStorageReader

@Deprecated
public MboxrdStorageReader(InputStream stream,
                              boolean leaveOpen)

Deprecated. This ctor is obsolete and will be removed soon. Please use ctor with MboxLoadOptions

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

stream - The stream.

leaveOpen - if set to true leaves the underlying stream open after disposing.

Throws:

ArgumentNullException - If given stream is null.

MboxrdStorageReader

@Deprecated
public MboxrdStorageReader(com.aspose.ms.System.IO.Stream stream,
                              boolean leaveOpen)

Deprecated. This ctor is obsolete and will be removed soon. Please use ctor with MboxLoadOptions

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

stream - The stream.

leaveOpen - if set to true leaves the underlying stream open after disposing.

Throws:

ArgumentNullException - If given stream is null.

MboxrdStorageReader

@Deprecated
public MboxrdStorageReader(String fileName,
                              boolean leaveOpen)

Deprecated. This ctor is obsolete and will be removed soon. Please use ctor with MboxLoadOptions

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

fileName - Name of the file.

leaveOpen - if set to true leaves the underlying stream open after disposing.

Throws:

ArgumentNullException - If filename is null or empty.

MboxrdStorageReader

public MboxrdStorageReader(InputStream stream,
                   MboxLoadOptions options)

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

stream - The stream.

options - additional options when loading a Mbox storageMboxLoadOptions.

MboxrdStorageReader

public MboxrdStorageReader(com.aspose.ms.System.IO.Stream stream,
                   MboxLoadOptions options)

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

stream - The stream.

options - additional options when loading a Mbox storageMboxLoadOptions.

MboxrdStorageReader

public MboxrdStorageReader(String fileName,
                   MboxLoadOptions options)

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

fileName - Name of the file.

options - additional options when loading a Mbox storageMboxLoadOptions.

Throws:

ArgumentNullException - If filename is null or empty.

Method Detail

readNextMessage

public MailMessage readNextMessage(String[] fromMarker)

Reads the next message from underlying storage stream.

Specified by:

readNextMessage in class MboxStorageReader

Parameters:

fromMarker - Gets the From Marker while parsing the MBox Storage file.

Returns:

A MailMessage object if it can be read or <b>null</b> if no more messages are available.

readNextMessage

public MailMessage readNextMessage()

Reads the next message from underlying storage stream.

Specified by:

readNextMessage in class MboxStorageReader

Returns:

A MailMessage object if it can be read or <b>null</b> if no more messages are available.

getTotalItemsCount

public int getTotalItemsCount()

Returns the number of messages in a storage.

Specified by:

getTotalItemsCount in class MboxStorageReader

Returns:

Returns the number of messages in a storage.