Aspose::Email::Storage::Mbox::MboxoStorageReader Class Referencefinal

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

Inherits Aspose::Email::Storage::Mbox::MboxStorageReader.

Public Member Functions

 MboxoStorageReader (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< MboxLoadOptions > options)
 Initializes a new instance of the MboxoStorageReader class. More...
 
 MboxoStorageReader (System::String fileName, System::SharedPtr< MboxLoadOptions > options)
 Initializes a new instance of the MboxrdStorageReader class. More...
 
System::SharedPtr< MailMessageReadNextMessage (System::String &fromMarker, System::SharedPtr< EmlLoadOptions > options) override
 Reads the next message from underlying storage stream. More...
 
System::SharedPtr< MboxMessageInfoNextMessage () override
 Gets the next message info. More...
 
int32_t GetTotalItemsCount () override
 Returns the number of messages in a storage. More...
 
System::SharedPtr< MailMessageReadNextMessage () override
 Reads the next message from underlying storage stream. More...
 
System::SharedPtr< MailMessageReadNextMessage (System::String &fromMarker) override
 Reads the next message from underlying storage stream. More...
 
System::SharedPtr< MailMessageReadNextMessage (System::SharedPtr< EmlLoadOptions > options) override
 Reads the next message from underlying storage stream. More...
 
- Public Member Functions inherited from Aspose::Email::Storage::Mbox::MboxStorageReader
System::SharedPtr< System::IO::Stream > get_BaseStream () const
 Gets the base stream. More...
 
int64_t get_CurrentDataSize () const
 Gets the number of bytes that is read by ReadNextMessage method. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< MailMessage > > > EnumerateMessages ()
 Exposes the enumerator, which supports an iteration of messages in storage. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< MboxMessageInfo > > > EnumerateMessageInfo ()
 Exposes the enumerator, which supports an iteration of messages in storage. More...
 
System::SharedPtr< MailMessageExtractMessage (System::String id, System::SharedPtr< EmlLoadOptions > options)
 Get the message from MBOX. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< MailMessage > > > EnumerateMessages (System::SharedPtr< EmlLoadOptions > options)
 Exposes the enumerator, which supports an iteration of messages in storage. More...
 
void SplitInto (int64_t chunkSize, System::String outputPath)
 Splits the mbox storage into less sized parts. More...
 
void SplitInto (int64_t chunkSize, System::String outputPath, System::String partFileNamePrefix)
 Splits the mbox storage into less sized parts. More...
 
void Dispose () override
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
VentureLicenseState GetVentureLicenseState ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Aspose::Email::Storage::Mbox::MboxStorageReader
static System::SharedPtr< MboxStorageReaderCreateReader (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< MboxLoadOptions > options)
 Creates the instance of reader. More...
 
static System::SharedPtr< MboxStorageReaderCreateReader (System::String fileName, System::SharedPtr< MboxLoadOptions > options)
 Creates the instance of reader. More...
 
static bool ByteArrayStartsFromMarker (System::ArrayPtr< uint8_t > array, System::ArrayPtr< uint8_t > marker)
 Checks whether the array starts from given marker. More...
 
static bool ContainsAsctime (System::ArrayPtr< uint8_t > currentLine)
 Determines whether the specified line contains asctime string. More...
 
static System::ArrayPtr< uint8_t > ReadLine (System::SharedPtr< System::IO::Stream > stream)
 Reads the line from stream. More...
 
- Public Attributes inherited from Aspose::Email::Storage::Mbox::MboxStorageReader
int32_t msgCount
 
System::SharedPtr< System::Object > mVentureLicense
 
System::Event< void(System::SharedPtr< System::Object >, System::SharedPtr< MimeItemCopyEventArgs >)> EmlCopying
 Event that occurs before the MailMessage object copy process, within the SplitInto(long, string) method. More...
 
System::Event< void(System::SharedPtr< System::Object >, System::SharedPtr< MimeItemCopyEventArgs >)> EmlCopied
 Event that occurs after successful copy of a MailMessage object within the SplitInto(long, string) method. More...
 
System::Event< void(System::SharedPtr< System::Object >, System::SharedPtr< NewStorageEventArgs >)> MboxFileCreated
 Event that occurs when a new MBOX file is created during the SplitInto(long, string) method. More...
 
System::Event< void(System::SharedPtr< System::Object >, System::SharedPtr< NewStorageEventArgs >)> MboxFileFilled
 Event that occurs after filling an MBOX file with data within the SplitInto(long, string) method. More...
 
- Static Public Attributes inherited from Aspose::Email::Storage::Mbox::MboxStorageReader
static System::ArrayPtr< uint8_t > FromMarker
 "From " signature, indicates a start of the message. More...
 
static System::ArrayPtr< uint8_t > EmptyFromMarkerCRLF
 
static System::ArrayPtr< uint8_t > EmptyFromMarkerCR
 
static System::ArrayPtr< uint8_t > EmptyFromMarkerLF
 
static System::ArrayPtr< uint8_t > 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 ???@???' More...
 
- Protected Member Functions inherited from Aspose::Email::Storage::Mbox::MboxStorageReader
void set_CurrentDataSize (int64_t value)
 Gets the number of bytes that is read by ReadNextMessage method. More...
 
 MboxStorageReader (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< MboxLoadOptions > options)
 Initializes a new instance of the MboxStorageReader class. More...
 
 MboxStorageReader (System::String fileName, System::SharedPtr< MboxLoadOptions > options)
 Initializes a new instance of the MboxStorageReader class. More...
 
virtual void Dispose (bool disposing)
 Releases unmanaged and - optionally - managed resources More...
 
virtual ~MboxStorageReader ()
 
- Protected Attributes inherited from Aspose::Email::Storage::Mbox::MboxStorageReader
System::SharedPtr< System::Text::Encoding > preferredTextEncoding
 

Detailed Description

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

Constructor & Destructor Documentation

◆ MboxoStorageReader() [1/2]

Aspose::Email::Storage::Mbox::MboxoStorageReader::MboxoStorageReader ( System::SharedPtr< System::IO::Stream >  stream,
System::SharedPtr< MboxLoadOptions options 
)

Initializes a new instance of the MboxoStorageReader class.

Parameters
streamThe stream.
optionsadditional options when loading a Mbox storageMboxLoadOptions.
Exceptions
ArgumentNullExceptionIf given stream is null.

◆ MboxoStorageReader() [2/2]

Aspose::Email::Storage::Mbox::MboxoStorageReader::MboxoStorageReader ( System::String  fileName,
System::SharedPtr< MboxLoadOptions options 
)

Initializes a new instance of the MboxrdStorageReader class.

Parameters
fileNameName of the file.
optionsadditional options when loading a Mbox storageMboxLoadOptions.
Exceptions
ArgumentNullExceptionIf filename is null or empty.

Member Function Documentation

◆ GetTotalItemsCount()

int32_t Aspose::Email::Storage::Mbox::MboxoStorageReader::GetTotalItemsCount ( )
overridevirtual

Returns the number of messages in a storage.

Returns
Returns the number of messages in a storage.

Implements Aspose::Email::Storage::Mbox::MboxStorageReader.

◆ NextMessage()

System::SharedPtr<MboxMessageInfo> Aspose::Email::Storage::Mbox::MboxoStorageReader::NextMessage ( )
overridevirtual

Gets the next message info.

Returns
A MboxMessageInfo object if it can be read or null if no more messages are available.

Implements Aspose::Email::Storage::Mbox::MboxStorageReader.

◆ ReadNextMessage() [1/4]

System::SharedPtr<MailMessage> Aspose::Email::Storage::Mbox::MboxoStorageReader::ReadNextMessage ( )
overridevirtual

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.

Implements Aspose::Email::Storage::Mbox::MboxStorageReader.

◆ ReadNextMessage() [2/4]

System::SharedPtr<MailMessage> Aspose::Email::Storage::Mbox::MboxoStorageReader::ReadNextMessage ( System::SharedPtr< EmlLoadOptions options)
overridevirtual

Reads the next message from underlying storage stream.

Parameters
optionsSpecifies EmlLoadOptions when reading message from Mbox storage.
Returns
A MailMessage object if it can be read or null if no more messages are available.

Implements Aspose::Email::Storage::Mbox::MboxStorageReader.

◆ ReadNextMessage() [3/4]

System::SharedPtr<MailMessage> Aspose::Email::Storage::Mbox::MboxoStorageReader::ReadNextMessage ( System::String &  fromMarker)
overridevirtual

Reads the next message from underlying storage stream.

Parameters
fromMarkerGets 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.

Implements Aspose::Email::Storage::Mbox::MboxStorageReader.

◆ ReadNextMessage() [4/4]

System::SharedPtr<MailMessage> Aspose::Email::Storage::Mbox::MboxoStorageReader::ReadNextMessage ( System::String &  fromMarker,
System::SharedPtr< EmlLoadOptions options 
)
overridevirtual

Reads the next message from underlying storage stream.

Parameters
fromMarkerGets the From Marker while parsing the MBox Storage file.
optionsSpecifies EmlLoadOptions when reading message from Mbox storage.
Returns
A MailMessage object if it can be read or null if no more messages are available.

Implements Aspose::Email::Storage::Mbox::MboxStorageReader.