MboxrdStorageReader

Inheritance: java.lang.Object, com.aspose.email.MboxStorageReader

public final class MboxrdStorageReader extends MboxStorageReader

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

Constructors

Constructor Description
MboxrdStorageReader(InputStream stream, boolean leaveOpen) Initializes a new instance of the MboxrdStorageReader class.
MboxrdStorageReader(System.IO.Stream stream, boolean leaveOpen) Initializes a new instance of the MboxrdStorageReader class.
MboxrdStorageReader(String fileName, boolean leaveOpen) Initializes a new instance of the MboxrdStorageReader class.
MboxrdStorageReader(InputStream stream, MboxLoadOptions options) Initializes a new instance of the MboxrdStorageReader class.
MboxrdStorageReader(System.IO.Stream stream, MboxLoadOptions options) Initializes a new instance of the MboxrdStorageReader class.
MboxrdStorageReader(String fileName, MboxLoadOptions options) Initializes a new instance of the MboxrdStorageReader class.

Methods

Method Description
readNextMessage(String[] fromMarker) Reads the next message from underlying storage stream.
readNextMessage(EmlLoadOptions options) Reads the next message from underlying storage stream.
readNextMessage(String[] fromMarker, EmlLoadOptions options) Reads the next message from underlying storage stream.
readNextMessage() Reads the next message from underlying storage stream.
getTotalItemsCount() Returns the number of messages in a storage.

MboxrdStorageReader(InputStream stream, boolean leaveOpen)

public MboxrdStorageReader(InputStream stream, boolean leaveOpen)

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

Parameter Type Description
stream java.io.InputStream The stream.
leaveOpen boolean if set to ``` true ``` leaves the underlying stream open after disposing.

MboxrdStorageReader(System.IO.Stream stream, boolean leaveOpen)

public MboxrdStorageReader(System.IO.Stream stream, boolean leaveOpen)

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

Parameter Type Description
stream com.aspose.ms.System.IO.Stream The stream.
leaveOpen boolean if set to ``` true ``` leaves the underlying stream open after disposing.

MboxrdStorageReader(String fileName, boolean leaveOpen)

public MboxrdStorageReader(String fileName, boolean leaveOpen)

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

Parameter Type Description
fileName java.lang.String Name of the file.
leaveOpen boolean if set to ``` true ``` leaves the underlying stream open after disposing.

MboxrdStorageReader(InputStream stream, MboxLoadOptions options)

public MboxrdStorageReader(InputStream stream, MboxLoadOptions options)

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

Parameter Type Description
stream java.io.InputStream The stream.
options MboxLoadOptions additional options when loading a Mbox storageMboxLoadOptions.

MboxrdStorageReader(System.IO.Stream stream, MboxLoadOptions options)

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

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

Parameter Type Description
stream com.aspose.ms.System.IO.Stream The stream.
options MboxLoadOptions additional options when loading a Mbox storageMboxLoadOptions.

MboxrdStorageReader(String fileName, MboxLoadOptions options)

public MboxrdStorageReader(String fileName, MboxLoadOptions options)

Initializes a new instance of the MboxrdStorageReader class.

Parameters:

Parameter Type Description
fileName java.lang.String Name of the file.
options MboxLoadOptions additional options when loading a Mbox storageMboxLoadOptions.

readNextMessage(String[] fromMarker)

public MailMessage readNextMessage(String[] fromMarker)

Reads the next message from underlying storage stream.

Parameters:

Parameter Type Description
fromMarker java.lang.String[] Gets the From Marker while parsing the MBox Storage file.

Returns: MailMessage - A MailMessage object if it can be read or ``` null ``` if no more messages are available.

readNextMessage(EmlLoadOptions options)

public MailMessage readNextMessage(EmlLoadOptions options)

Reads the next message from underlying storage stream.

Parameters:

Parameter Type Description
options EmlLoadOptions Specifies EmlLoadOptions when reading message from Mbox storage.

Returns: MailMessage - A MailMessage object if it can be read or ``` null ``` if no more messages are available.

readNextMessage(String[] fromMarker, EmlLoadOptions options)

public MailMessage readNextMessage(String[] fromMarker, EmlLoadOptions options)

Reads the next message from underlying storage stream.

Parameters:

Parameter Type Description
fromMarker java.lang.String[] Gets the From Marker while parsing the MBox Storage file.
options EmlLoadOptions Specifies EmlLoadOptions when reading message from Mbox storage.

Returns: MailMessage - A MailMessage object if it can be read or ``` null ``` if no more messages are available.

readNextMessage()

public MailMessage readNextMessage()

Reads the next message from underlying storage stream.

Returns: MailMessage - A MailMessage object if it can be read or ``` null ``` if no more messages are available.

getTotalItemsCount()

public int getTotalItemsCount()

Returns the number of messages in a storage.

Returns: int - Returns the number of messages in a storage.