com.aspose.email

Class MboxoStorageReader

java.lang.Object

com.aspose.email.MboxStorageReader

com.aspose.email.MboxoStorageReader

All Implemented Interfaces:

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

public final class MboxoStorageReader
extends MboxStorageReader

Represents mboxo format storage reader, this format is being used by Eudora.

Field Summary

Fields inherited from class com.aspose.email.MboxStorageReader

EmptyFromMarkerCR, EmptyFromMarkerCRLF, EmptyFromMarkerLF, FromMarker, MboxoMarker, preferredTextEncoding

Constructor Summary

Constructors

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

MboxoStorageReader

@Deprecated
public MboxoStorageReader(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 MboxoStorageReader class.

Parameters:

stream - The stream.

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

Throws:

com.aspose.ms.System.ArgumentNullException - If given stream is null.

MboxoStorageReader

@Deprecated
public MboxoStorageReader(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 MboxoStorageReader class.

Parameters:

stream - The stream.

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

Throws:

com.aspose.ms.System.ArgumentNullException - If given stream is null.

MboxoStorageReader

@Deprecated
public MboxoStorageReader(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:

com.aspose.ms.System.ArgumentNullException - If filename is null or empty.

MboxoStorageReader

public MboxoStorageReader(InputStream stream,
                  MboxLoadOptions options)

Initializes a new instance of the MboxoStorageReader class.

Parameters:

stream - The stream.

options - additional options when loading a Mbox storageMboxLoadOptions.

Throws:

com.aspose.ms.System.ArgumentNullException - If given stream is null.

MboxoStorageReader

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

Initializes a new instance of the MboxoStorageReader class.

Parameters:

stream - The stream.

options - additional options when loading a Mbox storageMboxLoadOptions.

Throws:

com.aspose.ms.System.ArgumentNullException - If given stream is null.

MboxoStorageReader

public MboxoStorageReader(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:

com.aspose.ms.System.ArgumentNullException - If filename is null or empty.

Method Detail

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.

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.

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.