Aspose::Email::Storage::Olm::OlmStorage Class Reference

Represents Outlook for Mac storage (.OLM) file. More...

Inherits IDisposable.

Public Member Functions

ASPOSE_EMAIL_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< OlmFolder > > > get_FolderHierarchy () const
 Gets the folder hierarchy. More...
 
ASPOSE_EMAIL_SHARED_API OlmStorage (System::String fileName)
 Initializes a new instance of the OlmStorage class. More...
 
ASPOSE_EMAIL_SHARED_API OlmStorage (System::SharedPtr< System::IO::Stream > stream)
 Initializes a new instance of the OlmStorage class. More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Email::Mapi::MapiMessage > > > EnumerateMessages (System::SharedPtr< OlmFolder > folder)
 Exposes the enumerator, which supports an iteration of messages in folder. More...
 
ASPOSE_EMAIL_SHARED_API void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 

Protected Member Functions

virtual ASPOSE_EMAIL_SHARED_API void Dispose (bool disposing)
 Releases unmanaged and - optionally - managed resources. More...
 

Detailed Description

Represents Outlook for Mac storage (.OLM) file.

Constructor & Destructor Documentation

◆ OlmStorage() [1/2]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Storage::Olm::OlmStorage::OlmStorage ( System::String  fileName)

Initializes a new instance of the OlmStorage class.

Parameters
fileNameOLM file name.
Returns
Returns an OlmStorage instance which is loaded from the specified file.
Exceptions
ArgumentNullExceptionthrows if file name is null or empty

◆ OlmStorage() [2/2]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Storage::Olm::OlmStorage::OlmStorage ( System::SharedPtr< System::IO::Stream >  stream)

Initializes a new instance of the OlmStorage class.

Parameters
streamSource stream System::IO::Stream with OLM storage data.
Returns
Returns an OlmStorage instance which is loaded from the specified stream.
Exceptions
ArgumentNullExceptionthrows if stream is null

Member Function Documentation

◆ Dispose() [1/2]

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Storage::Olm::OlmStorage::Dispose ( )

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

◆ Dispose() [2/2]

virtual ASPOSE_EMAIL_SHARED_API void Aspose::Email::Storage::Olm::OlmStorage::Dispose ( bool  disposing)
protectedvirtual

Releases unmanaged and - optionally - managed resources.

Parameters
disposingtrue to release both managed and unmanaged resources; false to release only unmanaged resources.

◆ EnumerateMessages()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<Aspose::Email::Mapi::MapiMessage> > > Aspose::Email::Storage::Olm::OlmStorage::EnumerateMessages ( System::SharedPtr< OlmFolder folder)

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

Parameters
folderOlmFolder that represents information about folder in OLM storage.
Returns
System::Collections::Generic::IEnumerable<T>, that represents an enumerator that iterates through a messages in folder.
Exceptions
ArgumentNullExceptionthrows if folder is null

◆ get_FolderHierarchy()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<OlmFolder> > > Aspose::Email::Storage::Olm::OlmStorage::get_FolderHierarchy ( ) const

Gets the folder hierarchy.

The folder hierarchy.