Aspose::Email::Storage::MailStorageConverter Class Reference

Mail storage converter provides services for storage conversion operations. More...

Inherits Object.

Public Types

using MailHandler = System::MulticastDelegate< void(System::SharedPtr< MailMessage >)>
 Represents the method that will handle an event that occurs after successfully reading a message from the Mbox and before adding it to Pst.
More...
 

Public Member Functions

 MailStorageConverter ()=delete
 

Static Public Member Functions

static System::SharedPtr< EmlLoadOptionsget_MboxMessageOptions ()
 Gets email load options when parsing an Mbox storage. More...
 
static void set_MboxMessageOptions (System::SharedPtr< EmlLoadOptions > value)
 Sets email load options when parsing an Mbox storage. More...
 
static System::SharedPtr< Pst::PersonalStorageMboxToPst (System::String mboxFileName, System::String pstFileName)
 Converts an Mbox storage to PST. More...
 
static System::SharedPtr< Pst::PersonalStorageMboxToPst (System::String mboxFileName, System::String pstFileName, MailStorageConverter::MailHandler mailHandler)
 Converts an Mbox storage to PST. More...
 
static System::SharedPtr< Pst::PersonalStorageMboxToPst (System::SharedPtr< System::IO::Stream > mboxrdDataStream, System::String pstFileName)
 Converts an Mbox storage to PST. More...
 
static System::SharedPtr< Pst::PersonalStorageMboxToPst (System::SharedPtr< System::IO::Stream > mboxrdDataStream, System::String pstFileName, MailStorageConverter::MailHandler mailHandler)
 Converts an Mbox storage to PST. More...
 
static System::SharedPtr< Pst::PersonalStorageMboxToPst (System::String mboxFileName, System::SharedPtr< System::IO::Stream > pstDataStream)
 Converts an Mbox storage to PST. More...
 
static System::SharedPtr< Pst::PersonalStorageMboxToPst (System::String mboxFileName, System::SharedPtr< System::IO::Stream > pstDataStream, MailStorageConverter::MailHandler mailHandler)
 Converts an Mbox storage to PST. More...
 
static System::SharedPtr< Pst::PersonalStorageMboxToPst (System::SharedPtr< System::IO::Stream > mboxrdDataStream, System::SharedPtr< System::IO::Stream > pstDataStream)
 Converts an Mbox storage to PST. More...
 
static System::SharedPtr< Pst::PersonalStorageMboxToPst (System::SharedPtr< System::IO::Stream > mboxrdDataStream, System::SharedPtr< System::IO::Stream > pstDataStream, MailStorageConverter::MailHandler mailHandler)
 Converts an Mbox storage to PST. More...
 
static void MboxToPst (System::SharedPtr< Mbox::MboxStorageReader > mboxStorageReader, System::SharedPtr< Pst::PersonalStorage > pst, System::String pstFolderName, MailStorageConverter::MailHandler mailHandler)
 Converts an Mbox storage to PST. More...
 
static System::SharedPtr< Pst::PersonalStorageMboxToPst (System::String mboxFileName, System::String pstFileName, System::SharedPtr< MboxToPstConversionOptions > options)
 Converts an Mbox storage to PST. More...
 
static System::SharedPtr< Pst::PersonalStorageMboxToPst (System::SharedPtr< System::IO::Stream > mboxrdDataStream, System::SharedPtr< System::IO::Stream > pstDataStream, System::SharedPtr< MboxToPstConversionOptions > options)
 Converts an Mbox storage to PST. More...
 
static void MboxToPst (System::SharedPtr< Mbox::MboxStorageReader > mboxStorageReader, System::SharedPtr< Pst::PersonalStorage > pst, System::String pstFolderName, System::SharedPtr< MboxToPstConversionOptions > options)
 Converts an Mbox storage to PST. More...
 

Detailed Description

Mail storage converter provides services for storage conversion operations.

Member Typedef Documentation

◆ MailHandler

using Aspose::Email::Storage::MailStorageConverter::MailHandler = System::MulticastDelegate<void(System::SharedPtr<MailMessage>)>

Represents the method that will handle an event that occurs after successfully reading a message from the Mbox and before adding it to Pst.

The handler can be used to any additional message changes before adding to the PST.

Constructor & Destructor Documentation

◆ MailStorageConverter()

Aspose::Email::Storage::MailStorageConverter::MailStorageConverter ( )
delete

Member Function Documentation

◆ get_MboxMessageOptions()

static System::SharedPtr<EmlLoadOptions> Aspose::Email::Storage::MailStorageConverter::get_MboxMessageOptions ( )
static

Gets email load options when parsing an Mbox storage.

The EmlLoadOptions that specifies load options.

◆ MboxToPst() [1/12]

static void Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::SharedPtr< Mbox::MboxStorageReader mboxStorageReader,
System::SharedPtr< Pst::PersonalStorage pst,
System::String  pstFolderName,
MailStorageConverter::MailHandler  mailHandler 
)
static

Converts an Mbox storage to PST.

Parameters
mboxStorageReaderAn MboxStorageReader that represents an mbox-based mail storage reader.
pstA PersonalStorage that represents a pst storage.
pstFolderNameThe 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.
mailHandlerThe MailHandler delegate is called for each message that is read from Mbox.
Returns
A PersonalStorage object that represents the converted storage.
Exceptions
ArgumentNullExceptionIf mboxStorageReader is null.
ArgumentNullExceptionIf pst is null.

◆ MboxToPst() [2/12]

static void Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::SharedPtr< Mbox::MboxStorageReader mboxStorageReader,
System::SharedPtr< Pst::PersonalStorage pst,
System::String  pstFolderName,
System::SharedPtr< MboxToPstConversionOptions options 
)
static

Converts an Mbox storage to PST.

Parameters
mboxStorageReaderAn MboxStorageReader that represents an mbox-based mail storage reader.
pstA PersonalStorage that represents a pst storage.
pstFolderNameThe 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.
optionsAn MboxToPstConversionOptions additional options when converting from Mbox to PST

◆ MboxToPst() [3/12]

static System::SharedPtr<Pst::PersonalStorage> Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::SharedPtr< System::IO::Stream >  mboxrdDataStream,
System::SharedPtr< System::IO::Stream >  pstDataStream 
)
static

Converts an Mbox storage to PST.

Parameters
mboxrdDataStreamA Stream that represents data in Mbox format.
pstDataStreamA Stream that represents data in Pst format.
Returns
A PersonalStorage object that represents the converted storage.
Exceptions
ArgumentNullExceptionIf mboxrdDataStream is null.
ArgumentNullExceptionIf pstDataStream is null.

◆ MboxToPst() [4/12]

static System::SharedPtr<Pst::PersonalStorage> Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::SharedPtr< System::IO::Stream >  mboxrdDataStream,
System::SharedPtr< System::IO::Stream >  pstDataStream,
MailStorageConverter::MailHandler  mailHandler 
)
static

Converts an Mbox storage to PST.

Parameters
mboxrdDataStreamA Stream that represents data in Mbox format.
pstDataStreamA Stream that represents data in Pst format.
mailHandlerThe MailHandler delegate is called for each message that is read from Mbox.
Returns
A PersonalStorage object that represents the converted storage.
Exceptions
ArgumentNullExceptionIf mboxrdDataStream is null.
ArgumentNullExceptionIf pstDataStream is null.

◆ MboxToPst() [5/12]

static System::SharedPtr<Pst::PersonalStorage> Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::SharedPtr< System::IO::Stream >  mboxrdDataStream,
System::SharedPtr< System::IO::Stream >  pstDataStream,
System::SharedPtr< MboxToPstConversionOptions options 
)
static

Converts an Mbox storage to PST.

Parameters
mboxrdDataStreamA Stream that represents data in Mbox format.
pstDataStreamA Stream that represents data in Pst format.
optionsAn MboxToPstConversionOptions additional options when converting from Mbox to PST
Returns

◆ MboxToPst() [6/12]

static System::SharedPtr<Pst::PersonalStorage> Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::SharedPtr< System::IO::Stream >  mboxrdDataStream,
System::String  pstFileName 
)
static

Converts an Mbox storage to PST.

Parameters
mboxrdDataStreamA Stream that represents data in Mbox format.
pstFileNamePST file name.
Returns
A PersonalStorage object that represents the converted storage.
Exceptions
ArgumentNullExceptionIf mboxrdDataStream is null.
ArgumentExceptionIf pstFileName is null or empty.

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

◆ MboxToPst() [7/12]

static System::SharedPtr<Pst::PersonalStorage> Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::SharedPtr< System::IO::Stream >  mboxrdDataStream,
System::String  pstFileName,
MailStorageConverter::MailHandler  mailHandler 
)
static

Converts an Mbox storage to PST.

Parameters
mboxrdDataStreamA Stream that represents data in Mbox format.
pstFileNamePST file name.
mailHandlerThe MailHandler delegate is called for each message that is read from Mbox.
Returns
A PersonalStorage object that represents the converted storage.
Exceptions
ArgumentNullExceptionIf mboxrdDataStream is null.
ArgumentExceptionIf pstFileName is null or empty.

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

◆ MboxToPst() [8/12]

static System::SharedPtr<Pst::PersonalStorage> Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::String  mboxFileName,
System::SharedPtr< System::IO::Stream >  pstDataStream 
)
static

Converts an Mbox storage to PST.

Parameters
mboxFileNameMbox file name.
pstDataStreamA Stream that represents data in Pst format.
Returns
A PersonalStorage object that represents the converted storage.
Exceptions
ArgumentExceptionIf mboxFileName is null or empty.
ArgumentNullExceptionIf pstDataStream is null.

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

◆ MboxToPst() [9/12]

static System::SharedPtr<Pst::PersonalStorage> Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::String  mboxFileName,
System::SharedPtr< System::IO::Stream >  pstDataStream,
MailStorageConverter::MailHandler  mailHandler 
)
static

Converts an Mbox storage to PST.

Parameters
mboxFileNameMbox file name.
pstDataStreamA Stream that represents data in Pst format.
mailHandlerThe MailHandler delegate is called for each message that is read from Mbox.
Returns
A PersonalStorage object that represents the converted storage.
Exceptions
ArgumentExceptionIf mboxFileName is null or empty.
ArgumentNullExceptionIf pstDataStream is null.

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

◆ MboxToPst() [10/12]

static System::SharedPtr<Pst::PersonalStorage> Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::String  mboxFileName,
System::String  pstFileName 
)
static

Converts an Mbox storage to PST.

Parameters
mboxFileNameMbox file name.
pstFileNamePST file name.
Returns
A PersonalStorage object that represents the converted storage.
Exceptions
ArgumentExceptionIf mboxFileName is null or empty.
ArgumentExceptionIf pstFileName is null or empty.

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

◆ MboxToPst() [11/12]

static System::SharedPtr<Pst::PersonalStorage> Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::String  mboxFileName,
System::String  pstFileName,
MailStorageConverter::MailHandler  mailHandler 
)
static

Converts an Mbox storage to PST.

Parameters
mboxFileNameMbox file name.
pstFileNamePST file name.
mailHandlerThe MailHandler delegate is called for each message that is read from Mbox.
Returns
A PersonalStorage object that represents the converted storage.
Exceptions
ArgumentExceptionIf mboxFileName is null or empty.
ArgumentExceptionIf pstFileName is null or empty.

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

◆ MboxToPst() [12/12]

static System::SharedPtr<Pst::PersonalStorage> Aspose::Email::Storage::MailStorageConverter::MboxToPst ( System::String  mboxFileName,
System::String  pstFileName,
System::SharedPtr< MboxToPstConversionOptions options 
)
static

Converts an Mbox storage to PST.

Parameters
mboxFileNameMbox file name.
pstFileNamePST file name.
optionsAn MboxToPstConversionOptions additional options when converting from Mbox to PST
Returns

◆ set_MboxMessageOptions()

static void Aspose::Email::Storage::MailStorageConverter::set_MboxMessageOptions ( System::SharedPtr< EmlLoadOptions value)
static

Sets email load options when parsing an Mbox storage.

The EmlLoadOptions that specifies load options.