MboxStorageReader (Aspose.Email for Java 24.9 API Documentation)

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

Represents an MBOX file and provides methods for reading and extracting messages. The MBOX file format is used for storing a collection of email messages.

Example:

 // Create an instance of the MboxStorageReader using the factory method 'createReader'.
 MboxStorageReader mbox = MboxStorageReader.createReader("storage.mbox", new MboxLoadOptions());

 // Iterate through each message info object in the mbox storage.
 for (MboxMessageInfo mboxMessageInfo : mbox.enumerateMessageInfo()) {
     System.out.println("Subject: " + mboxMessageInfo.getSubject());
     System.out.println("From: " + mboxMessageInfo.getFrom());
     System.out.println("To: " + mboxMessageInfo.getTo());

     // Extract the full MIME message object from the MBOX storage using the message's unique entry ID.
     MailMessage eml = mbox.extractMessage(mboxMessageInfo.getEntryId(), new EmlLoadOptions());

     // Save the extracted MIME message as an .eml file.
     eml.save(eml.getSubject() + ".eml");
 }

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, MboxLoadOptions options)` Initializes a new instance of the `MboxStorageReader` class.
`protected`	`MboxStorageReader(Stream stream, MboxLoadOptions options)` Initializes a new instance of the `MboxStorageReader` class.
`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`	`cancel()` This method is used to interrupt a split operation if splitInto is running asynchronously.
`void`	`close()`
`protected static boolean`	`containsAsctime(byte[] currentLine)` Determines whether the specified line contains asctime string.
`static MboxStorageReader`	`createReader(InputStream stream, MboxLoadOptions options)` Creates the instance of reader.
`static MboxStorageReader`	`createReader(Stream stream, MboxLoadOptions options)` Creates the instance of reader.
`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.
`MimeItemCopyEventHandler`	`getEmlCopiedEventHandler()` Event that occurs after successful copy of a `MailMessage` object within the `splitInto(long,String)` method.
`MimeItemCopyEventHandler`	`getEmlCopyingEventHandler()` Event that occurs before the `MailMessage` object copy process, within the `splitInto(long,String)` method.
`NewStorageEventHandler`	`getMboxFileCreatedEventHandler()` Event that occurs when a new MBOX file is created during the `splitInto(long,String)` method.
`NewStorageEventHandler`	`getMboxFileFilledEventHandler()` Event that occurs after filling an MBOX file with data within the `splitInto(long,String)` 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.
`void`	`setEmlCopiedEventHandler(MimeItemCopyEventHandler value)` Event that occurs after successful copy of a `MailMessage` object within the `splitInto(long,String)` method.
`void`	`setEmlCopyingEventHandler(MimeItemCopyEventHandler value)` Event that occurs before the `MailMessage` object copy process, within the `splitInto(long,String)` method.
`void`	`setMboxFileCreatedEventHandler(NewStorageEventHandler value)` Event that occurs when a new MBOX file is created during the `splitInto(long,String)` method.
`void`	`setMboxFileFilledEventHandler(NewStorageEventHandler value)` Event that occurs after filling an MBOX file with data within the `splitInto(long,String)` method.
`void`	`splitInto(long chunkSize, String outputPath)` Splits the mbox storage into less sized parts.
`void`	`splitInto(long chunkSize, String outputPath, String partFileNamePrefix)` Splits the mbox storage into less sized parts.

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
```
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
 - getEmlCopyingEventHandler
```
public final MimeItemCopyEventHandler getEmlCopyingEventHandler()
```
 Event that occurs before the MailMessage object copy process, within the splitInto(long,String) method.
 - setEmlCopyingEventHandler
```
public final void setEmlCopyingEventHandler(MimeItemCopyEventHandler value)
```
 Event that occurs before the MailMessage object copy process, within the splitInto(long,String) method.
 - getEmlCopiedEventHandler
```
public final MimeItemCopyEventHandler getEmlCopiedEventHandler()
```
 Event that occurs after successful copy of a MailMessage object within the splitInto(long,String) method.
 - setEmlCopiedEventHandler
```
public final void setEmlCopiedEventHandler(MimeItemCopyEventHandler value)
```
 Event that occurs after successful copy of a MailMessage object within the splitInto(long,String) method.
 - getMboxFileCreatedEventHandler
```
public final NewStorageEventHandler getMboxFileCreatedEventHandler()
```
 Event that occurs when a new MBOX file is created during the splitInto(long,String) method.
 - setMboxFileCreatedEventHandler
```
public final void setMboxFileCreatedEventHandler(NewStorageEventHandler value)
```
 Event that occurs when a new MBOX file is created during the splitInto(long,String) method.
 - getMboxFileFilledEventHandler
```
public final NewStorageEventHandler getMboxFileFilledEventHandler()
```
 Event that occurs after filling an MBOX file with data within the splitInto(long,String) method.
 - setMboxFileFilledEventHandler
```
public final void setMboxFileFilledEventHandler(NewStorageEventHandler value)
```
 Event that occurs after filling an MBOX file with data within the splitInto(long,String) method.
 - 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
```
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
```
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.
 - splitInto
```
public final void splitInto(long chunkSize,
 String outputPath)
```
 Splits the mbox storage into less sized parts.
 
 Parameters:
 chunkSize - The approximate size of a chunk in bytes.
 outputPath - The folder path where chunks will be created.
 
 Throws:
 
 ArgumentException - Throws when the path parameter is null or empty.
 - splitInto
```
public final void splitInto(long chunkSize,
 String outputPath,
 String partFileNamePrefix)
```
 Splits the mbox storage into less sized parts.
 
 Parameters:
 chunkSize - The approximate size of a chunk in bytes.
 outputPath - The folder path where chunks will be created.
 - cancel
```
public final void cancel()
```
 This method is used to interrupt a split operation if splitInto is running asynchronously.
 - readNextMessage
```
public abstract MailMessage readNextMessage()
```
 Reads the next message from underlying storage stream.
 
 Returns:
 A MailMessage object if it can be read or null 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 null 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 null 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 null 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 null 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.

Class MboxStorageReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

preferredTextEncoding

FromMarker

EmptyFromMarkerCRLF

EmptyFromMarkerCR

EmptyFromMarkerLF

MboxoMarker

Constructor Detail

MboxStorageReader

MboxStorageReader

MboxStorageReader

Method Detail

getEmlCopyingEventHandler

setEmlCopyingEventHandler

getEmlCopiedEventHandler

setEmlCopiedEventHandler

getMboxFileCreatedEventHandler

setMboxFileCreatedEventHandler

getMboxFileFilledEventHandler

setMboxFileFilledEventHandler

getCurrentDataSize

setCurrentDataSize

createReader

createReader

createReader

enumerateMessages

enumerateMessageInfo

extractMessage

enumerateMessages

splitInto

splitInto

cancel

readNextMessage

readNextMessage

readNextMessage

readNextMessage

nextMessage

getTotalItemsCount

dispose

close

dispose

byteArrayStartsFromMarker

containsAsctime

readLine