com.aspose.email

Class MboxStorageReader

java.lang.Object

com.aspose.email.MboxStorageReader

All Implemented Interfaces:

IDisposable, Closeable, AutoCloseable

Direct Known Subclasses:

MboxoStorageReader, MboxrdStorageReader

public abstract class MboxStorageReader
extends Object
implements IDisposable, Closeable

A base class for any mbox-based mail storage reader.

Field Summary

Fields

Modifier and Type	Field and Description
protected static byte[]	EmptyFromMarkerCR
protected static byte[]	EmptyFromMarkerCRLF
protected static byte[]	EmptyFromMarkerLF
protected static byte[]	FromMarker "From " signature, indicates a start of the message.
protected static byte[]	MboxoMarker The mbox format uses a single blank line followed by the string 'From ' (with a space) to delimit messages.
protected Encoding	preferredTextEncoding

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MboxStorageReader(InputStream stream, boolean leaveOpen) Deprecated. This ctor is obsolete and will be removed soon. Please use ctor with MboxLoadOptions
protected	MboxStorageReader(InputStream stream, MboxLoadOptions options) Initializes a new instance of the MboxStorageReader class.
protected	MboxStorageReader(Stream stream, boolean leaveOpen) Deprecated. This ctor is obsolete and will be removed soon. Please use ctor with MboxLoadOptions
protected	MboxStorageReader(Stream stream, MboxLoadOptions options) Initializes a new instance of the MboxStorageReader class.
protected	MboxStorageReader(String fileName, boolean leaveOpen) Deprecated. This ctor is obsolete and will be removed soon. Please use ctor with MboxLoadOptions
protected	MboxStorageReader(String fileName, MboxLoadOptions options) Initializes a new instance of the MboxStorageReader class.

Method Summary

Methods

Modifier and Type	Method and Description
protected static boolean	byteArrayStartsFromMarker(byte[] array, byte[] marker) Checks whether the array starts from given marker.
void	close()
protected static boolean	containsAsctime(byte[] currentLine) Determines whether the specified line contains asctime string.
static MboxStorageReader	createReader(InputStream stream, boolean leaveOpen) Deprecated. This method is obsolete and will be removed soon. Please use method with MboxLoadOptions
static MboxStorageReader	createReader(InputStream stream, MboxLoadOptions options) Creates the instance of reader.
static MboxStorageReader	createReader(Stream stream, boolean leaveOpen) Deprecated. This method is obsolete and will be removed soon. Please use method with MboxLoadOptions
static MboxStorageReader	createReader(Stream stream, MboxLoadOptions options) Creates the instance of reader.
static MboxStorageReader	createReader(String fileName, boolean leaveOpen) Deprecated. This method is obsolete and will be removed soon. Please use method with MboxLoadOptions
static MboxStorageReader	createReader(String fileName, MboxLoadOptions options) Creates the instance of reader.
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
protected void	dispose(boolean disposing) Releases unmanaged and - optionally - managed resources
IGenericEnumerable<MboxMessageInfo>	enumerateMessageInfo() Exposes the enumerator, which supports an iteration of messages in storage.
IGenericEnumerable<MailMessage>	enumerateMessages() Exposes the enumerator, which supports an iteration of messages in storage.
IGenericEnumerable<MailMessage>	enumerateMessages(EmlLoadOptions options) Exposes the enumerator, which supports an iteration of messages in storage.
MailMessage	extractMessage(String id, EmlLoadOptions options) Get the message from MBOX.
long	getCurrentDataSize() Gets the number of bytes that is read by ReadNextMessage method.
abstract int	getTotalItemsCount() Returns the number of messages in a storage.
abstract MboxMessageInfo	nextMessage() Gets the next message info.
protected static byte[]	readLine(Stream stream) Reads the line from stream.
abstract MailMessage	readNextMessage() Reads the next message from underlying storage stream.
abstract MailMessage	readNextMessage(EmlLoadOptions options) Reads the next message from underlying storage stream.
abstract MailMessage	readNextMessage(String[] fromMarker) Reads the next message from underlying storage stream.
abstract MailMessage	readNextMessage(String[] fromMarker, EmlLoadOptions options) Reads the next message from underlying storage stream.
protected void	setCurrentDataSize(long value) Gets the number of bytes that is read by ReadNextMessage method.

Methods inherited from class java.lang.Object

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

Field Detail

preferredTextEncoding

protected final Encoding preferredTextEncoding

FromMarker

protected static final byte[] FromMarker

"From " signature, indicates a start of the message.

EmptyFromMarkerCRLF

protected static final byte[] EmptyFromMarkerCRLF

EmptyFromMarkerCR

protected static final byte[] EmptyFromMarkerCR

EmptyFromMarkerLF

protected static final byte[] EmptyFromMarkerLF

MboxoMarker

protected static final byte[] MboxoMarker

The mbox format uses a single blank line followed by the string 'From ' (with a space) to delimit messages. In mboxo format sender's email address in message delimiter is replaced by the constant string '???@???', i.e. 'From ???@???'

Constructor Detail

MboxStorageReader

@Deprecated
protected MboxStorageReader(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 MboxStorageReader class.

Parameters:

stream - The stream.

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

Throws:

ArgumentNullException - If given stream is null.

MboxStorageReader

@Deprecated
protected MboxStorageReader(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 MboxStorageReader class.

Parameters:

stream - The stream.

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

Throws:

ArgumentNullException - If given stream is null.

MboxStorageReader

@Deprecated
protected MboxStorageReader(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 MboxStorageReader 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.

MboxStorageReader

protected MboxStorageReader(InputStream stream,
                 MboxLoadOptions options)

Initializes a new instance of the MboxStorageReader class.

Parameters:

stream - The stream.

options - additional options when loading a Mbox storageMboxLoadOptions.

Throws:

ArgumentNullException - If given stream is null.

MboxStorageReader

protected MboxStorageReader(Stream stream,
                 MboxLoadOptions options)

Initializes a new instance of the MboxStorageReader class.

Parameters:

stream - The stream.

options - additional options when loading a Mbox storageMboxLoadOptions.

Throws:

ArgumentNullException - If given stream is null.

MboxStorageReader

protected MboxStorageReader(String fileName,
                 MboxLoadOptions options)

Initializes a new instance of the MboxStorageReader 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

getCurrentDataSize

public final long getCurrentDataSize()

Gets the number of bytes that is read by ReadNextMessage method.

setCurrentDataSize

protected final void setCurrentDataSize(long value)

Gets the number of bytes that is read by ReadNextMessage method.

createReader

@Deprecated
public static MboxStorageReader createReader(InputStream stream,
                                        boolean leaveOpen)

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

Creates the instance of reader.

Parameters:

stream - The stream.

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

Returns:

Throws:

ArgumentNullException

createReader

@Deprecated
public static MboxStorageReader createReader(Stream stream,
                                        boolean leaveOpen)

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

Creates the instance of reader.

Parameters:

stream - The stream.

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

Returns:

Throws:

ArgumentNullException

createReader

public static MboxStorageReader createReader(InputStream stream,
                             MboxLoadOptions options)

Creates the instance of reader.

Parameters:

stream - The stream.

options - additional options when loading a Mbox storageMboxLoadOptions.

Returns:

Throws:

ArgumentNullException

createReader

public static MboxStorageReader createReader(Stream stream,
                             MboxLoadOptions options)

Creates the instance of reader.

Parameters:

stream - The stream.

options - additional options when loading a Mbox storageMboxLoadOptions.

Returns:

Throws:

ArgumentNullException

createReader

@Deprecated
public static MboxStorageReader createReader(String fileName,
                                        boolean leaveOpen)

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

Creates the instance of reader.

Parameters:

fileName -

leaveOpen -

Returns:

Throws:

ArgumentNullException

createReader

public static MboxStorageReader createReader(String fileName,
                             MboxLoadOptions options)

Creates the instance of reader.

Parameters:

fileName -

options - additional options when loading a Mbox storageMboxLoadOptions.

Returns:

Throws:

ArgumentNullException

enumerateMessages

public final IGenericEnumerable<MailMessage> enumerateMessages()

Exposes the enumerator, which supports an iteration of messages in storage.

Returns:

System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through a messages in storage.

enumerateMessageInfo

public final IGenericEnumerable<MboxMessageInfo> enumerateMessageInfo()

Exposes the enumerator, which supports an iteration of messages in storage.

Returns:

System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through a messages in storage.

extractMessage

public final MailMessage extractMessage(String id,
                         EmlLoadOptions options)

Get the message from MBOX.

Parameters:

id - String representation of EntryId.

options - Specifies EmlLoadOptions when reading message from Mbox storage.

Returns:

A MailMessage object.

enumerateMessages

public final IGenericEnumerable<MailMessage> enumerateMessages(EmlLoadOptions options)

Exposes the enumerator, which supports an iteration of messages in storage.

Parameters:

options - Specifies EmlLoadOptions when reading message from Mbox storage.

Returns:

System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through a messages in storage.

readNextMessage

public abstract MailMessage readNextMessage()

Reads the next message from underlying storage stream.

Returns:

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

readNextMessage

public abstract MailMessage readNextMessage(String[] fromMarker)

Reads the next message from underlying storage stream.

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 abstract MailMessage readNextMessage(EmlLoadOptions options)

Reads the next message from underlying storage stream.

Parameters:

options - Specifies EmlLoadOptions when reading message from Mbox storage.

Returns:

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

readNextMessage

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

Reads the next message from underlying storage stream.

Parameters:

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

options - Specifies EmlLoadOptions when reading message from Mbox storage.

Returns:

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

nextMessage

public abstract MboxMessageInfo nextMessage()

Gets the next message info.

Returns:

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

getTotalItemsCount

public abstract int getTotalItemsCount()

Returns the number of messages in a storage.

Returns:

Returns the number of messages in a storage.

dispose

public final void dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Specified by:

dispose in interface IDisposable

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

dispose

protected void dispose(boolean disposing)

Releases unmanaged and - optionally - managed resources

Parameters:

disposing - true to release both managed and unmanaged resources; false to release only unmanaged resources.

byteArrayStartsFromMarker

protected static boolean byteArrayStartsFromMarker(byte[] array,
                                byte[] marker)

Checks whether the array starts from given marker.

Parameters:

array - The array, can be null.

marker - The marker, can't be null.

Returns:

Boolean value indicating the result of operation.

containsAsctime

protected static boolean containsAsctime(byte[] currentLine)

Determines whether the specified line contains asctime string.

Parameters:

currentLine - The current line.

Returns:

true if the specified current line contains asctime; otherwise, false.

readLine

protected static byte[] readLine(Stream stream)

Reads the line from stream.

Parameters:

stream - The stream.

Returns:

The line read.