com.aspose.email

Class MailStorageConverter

java.lang.Object

com.aspose.email.MailStorageConverter

public class MailStorageConverter
extends Object

Mail storage converter provides services for storage conversion operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MailStorageConverter.MailHandler Represents the method that will handle an event that occurs after successfully reading a message from the Mbox and before adding it to Pst.

Constructor Summary

Constructors

Constructor and Description
MailStorageConverter()

Method Summary

Methods

Modifier and Type	Method and Description
static EmlLoadOptions	getMboxMessageOptions() Gets or sets email load options when parsing an Mbox storage.
static PersonalStorage	mboxToPst(InputStream mboxrdDataStream, OutputStream pstDataStream) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(InputStream mboxrdDataStream, OutputStream pstDataStream, MailStorageConverter.MailHandler mailHandler) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(InputStream mboxrdDataStream, OutputStream pstDataStream, MboxToPstConversionOptions options) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(InputStream mboxrdDataStream, String pstFileName) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(InputStream mboxrdDataStream, String pstFileName, MailStorageConverter.MailHandler mailHandler) Converts an Mbox storage to PST.
static void	mboxToPst(MboxStorageReader mboxStorageReader, PersonalStorage pst, String pstFolderName, MailStorageConverter.MailHandler mailHandler) Converts an Mbox storage to PST.
static void	mboxToPst(MboxStorageReader mboxStorageReader, PersonalStorage pst, String pstFolderName, MboxToPstConversionOptions options) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(Stream mboxrdDataStream, Stream pstDataStream)
static PersonalStorage	mboxToPst(Stream mboxrdDataStream, Stream pstDataStream, MailStorageConverter.MailHandler mailHandler)
static PersonalStorage	mboxToPst(Stream mboxrdDataStream, Stream pstDataStream, MboxToPstConversionOptions options)
static PersonalStorage	mboxToPst(String mboxFileName, OutputStream pstDataStream) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(String mboxFileName, OutputStream pstDataStream, MailStorageConverter.MailHandler mailHandler) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(String mboxFileName, Stream pstDataStream) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(String mboxFileName, Stream pstDataStream, MailStorageConverter.MailHandler mailHandler) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(String mboxFileName, String pstFileName) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(String mboxFileName, String pstFileName, MailStorageConverter.MailHandler mailHandler) Converts an Mbox storage to PST.
static PersonalStorage	mboxToPst(String mboxFileName, String pstFileName, MboxToPstConversionOptions options) Converts an Mbox storage to PST.
static void	setMboxMessageOptions(EmlLoadOptions value) Gets or sets email load options when parsing an Mbox storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailStorageConverter

public MailStorageConverter()

Method Detail

getMboxMessageOptions

public static EmlLoadOptions getMboxMessageOptions()

Gets or sets email load options when parsing an Mbox storage.

Value: The EmlLoadOptions that specifies load options.

setMboxMessageOptions

public static void setMboxMessageOptions(EmlLoadOptions value)

Gets or sets email load options when parsing an Mbox storage.

Value: The EmlLoadOptions that specifies load options.

mboxToPst

public static PersonalStorage mboxToPst(String mboxFileName,
                        String pstFileName)

Converts an Mbox storage to PST.

Parameters:

mboxFileName - Mbox file name.

pstFileName - PST file name.

In addition the same set of exceptions can be thrown as for FileStream creation using the open/read, create/write mode.

Returns:

A PersonalStorage object that represents the converted storage.

Throws:

ArgumentException - If mboxFileName is null or empty.

ArgumentException - If pstFileName is null or empty.

mboxToPst

public static PersonalStorage mboxToPst(String mboxFileName,
                        String pstFileName,
                        MailStorageConverter.MailHandler mailHandler)

Converts an Mbox storage to PST.

Parameters:

mboxFileName - Mbox file name.

pstFileName - PST file name.

mailHandler - The MailStorageConverter.MailHandler delegate is called for each message that is read from Mbox.

In addition the same set of exceptions can be thrown as for FileStream creation using the open/read, create/write mode.

Returns:

A PersonalStorage object that represents the converted storage.

Throws:

ArgumentException - If mboxFileName is null or empty.

ArgumentException - If pstFileName is null or empty.

mboxToPst

public static PersonalStorage mboxToPst(InputStream mboxrdDataStream,
                        String pstFileName)

Converts an Mbox storage to PST.

Parameters:

mboxrdDataStream - A InputStream that represents data in Mbox format.

pstFileName - PST file name.

In addition the same set of exceptions can be thrown as for FileStream creation using the open/read, create/write mode.

Returns:

A PersonalStorage object that represents the converted storage.

Throws:

ArgumentNullException - If mboxrdDataStream is null.

ArgumentException - If pstFileName is null or empty.

mboxToPst

public static PersonalStorage mboxToPst(InputStream mboxrdDataStream,
                        String pstFileName,
                        MailStorageConverter.MailHandler mailHandler)

Converts an Mbox storage to PST.

Parameters:

mboxrdDataStream - A InputStream that represents data in Mbox format.

pstFileName - PST file name.

mailHandler - The MailStorageConverter.MailHandler delegate is called for each message that is read from Mbox.

In addition the same set of exceptions can be thrown as for FileStream creation using the open/read, create/write mode.

Returns:

A PersonalStorage object that represents the converted storage.

Throws:

ArgumentNullException - If mboxrdDataStream is null.

ArgumentException - If pstFileName is null or empty.

mboxToPst

public static PersonalStorage mboxToPst(String mboxFileName,
                        OutputStream pstDataStream)

Converts an Mbox storage to PST.

Parameters:

mboxFileName - Mbox file name.

pstDataStream - A InputStream that represents data in Pst format.

In addition the same set of exceptions can be thrown as for FileStream creation using the open/read, create/write mode.

Returns:

A PersonalStorage object that represents the converted storage.

Throws:

ArgumentException - If mboxFileName is null or empty.

ArgumentNullException - If pstDataStream is null.

mboxToPst

public static PersonalStorage mboxToPst(String mboxFileName,
                        Stream pstDataStream)

Converts an Mbox storage to PST.

Parameters:

mboxFileName - Mbox file name.

pstDataStream - A Stream that represents data in Pst format.

In addition the same set of exceptions can be thrown as for FileStream creation using the open/read, create/write mode.

Returns:

A PersonalStorage object that represents the converted storage.

Throws:

ArgumentException - If mboxFileName is null or empty.

ArgumentNullException - If pstDataStream is null.

mboxToPst

public static PersonalStorage mboxToPst(String mboxFileName,
                        OutputStream pstDataStream,
                        MailStorageConverter.MailHandler mailHandler)

Converts an Mbox storage to PST.

Parameters:

mboxFileName - Mbox file name.

pstDataStream - A InputStream that represents data in Pst format.

mailHandler - The MailStorageConverter.MailHandler delegate is called for each message that is read from Mbox.

In addition the same set of exceptions can be thrown as for FileStream creation using the open/read, create/write mode.

Returns:

A PersonalStorage object that represents the converted storage.

Throws:

ArgumentException - If mboxFileName is null or empty.

ArgumentNullException - If pstDataStream is null.

mboxToPst

public static PersonalStorage mboxToPst(String mboxFileName,
                        Stream pstDataStream,
                        MailStorageConverter.MailHandler mailHandler)

Converts an Mbox storage to PST.

Parameters:

mboxFileName - Mbox file name.

pstDataStream - A Stream that represents data in Pst format.

mailHandler - The MailStorageConverter.MailHandler delegate is called for each message that is read from Mbox.

In addition the same set of exceptions can be thrown as for FileStream creation using the open/read, create/write mode.

Returns:

A PersonalStorage object that represents the converted storage.

Throws:

ArgumentException - If mboxFileName is null or empty.

ArgumentNullException - If pstDataStream is null.

mboxToPst

public static PersonalStorage mboxToPst(InputStream mboxrdDataStream,
                        OutputStream pstDataStream)

Converts an Mbox storage to PST.

Parameters:

mboxrdDataStream - A InputStream that represents data in Mbox format.

pstDataStream - A InputStream that represents data in Pst format.

Returns:

A PersonalStorage object that represents the converted storage.

Throws:

ArgumentNullException - If mboxrdDataStream is null.

ArgumentNullException - If pstDataStream is null.

mboxToPst

public static PersonalStorage mboxToPst(Stream mboxrdDataStream,
                        Stream pstDataStream)

mboxToPst

public static PersonalStorage mboxToPst(InputStream mboxrdDataStream,
                        OutputStream pstDataStream,
                        MailStorageConverter.MailHandler mailHandler)

Converts an Mbox storage to PST.

Parameters:

mboxrdDataStream - A InputStream that represents data in Mbox format.

pstDataStream - A InputStream that represents data in Pst format.

mailHandler - The MailStorageConverter.MailHandler delegate is called for each message that is read from Mbox.

Returns:

A PersonalStorage object that represents the converted storage.

Throws:

ArgumentNullException - If mboxrdDataStream is null.

ArgumentNullException - If pstDataStream is null.

mboxToPst

public static PersonalStorage mboxToPst(Stream mboxrdDataStream,
                        Stream pstDataStream,
                        MailStorageConverter.MailHandler mailHandler)

mboxToPst

public static void mboxToPst(MboxStorageReader mboxStorageReader,
             PersonalStorage pst,
             String pstFolderName,
             MailStorageConverter.MailHandler mailHandler)

Converts an Mbox storage to PST.

Parameters:

mboxStorageReader - An MboxStorageReader that represents an mbox-based mail storage reader.

pst - A PersonalStorage that represents a pst storage.

pstFolderName - The folder name, at the root of the pst, where Mbox messages will be added. If this folder doesn't exist, it will be created. If the folder exists and isn't empty, new messages will be added to the existing ones.

mailHandler - The MailStorageConverter.MailHandler delegate is called for each message that is read from Mbox.

Throws:

ArgumentNullException - If mboxStorageReader is null.

ArgumentNullException - If pst is null.

mboxToPst

public static PersonalStorage mboxToPst(String mboxFileName,
                        String pstFileName,
                        MboxToPstConversionOptions options)

Converts an Mbox storage to PST.

Parameters:

mboxFileName - Mbox file name.

pstFileName - PST file name.

options - An MboxToPstConversionOptions additional options when converting from Mbox to PST

Returns:

mboxToPst

public static PersonalStorage mboxToPst(InputStream mboxrdDataStream,
                        OutputStream pstDataStream,
                        MboxToPstConversionOptions options)

Converts an Mbox storage to PST.

Parameters:

mboxrdDataStream - A InputStream that represents data in Mbox format.

pstDataStream - A OutputStream that represents data in Pst format.

options - An MboxToPstConversionOptions additional options when converting from Mbox to PST

Returns:

mboxToPst

public static PersonalStorage mboxToPst(Stream mboxrdDataStream,
                        Stream pstDataStream,
                        MboxToPstConversionOptions options)

mboxToPst

public static void mboxToPst(MboxStorageReader mboxStorageReader,
             PersonalStorage pst,
             String pstFolderName,
             MboxToPstConversionOptions options)

Converts an Mbox storage to PST.

Parameters:

mboxStorageReader - An MboxStorageReader that represents an mbox-based mail storage reader.

pst - A PersonalStorage that represents a pst storage.

pstFolderName - The folder name, at the root of the pst, where Mbox messages will be added. If this folder doesn't exist, it will be created. If the folder exists and isn't empty, new messages will be added to the existing ones.

options - An MboxToPstConversionOptions additional options when converting from Mbox to PST