Represents folder information in OLM storage. More...
Inherits Object.
Public Member Functions | |
System::String | get_Name () const |
Gets the folder name. More... | |
System::SharedPtr< System::Collections::Generic::ListExt< System::SharedPtr< OlmFolder > > > | get_SubFolders () const |
Gets the list of sub-folders. More... | |
bool | get_HasMessages () |
Gets a value indicating whether the current folder has messages. More... | |
int32_t | get_MessageCount () const |
Gets the message count. More... | |
System::String | get_Path () const |
Gets the path. More... | |
System::String | get_FullPath () const |
Gets the full path. More... | |
int32_t | get_Depth () const |
Gets the depth. More... | |
OlmFolder (System::String fullPath, System::SharedPtr< OlmReader > reader) | |
Initializes a new instance of the OlmFolder class. More... | |
void | IncreaseMessageCount (int32_t count) |
Increases the message count. More... | |
System::SharedPtr< OlmFolder > | GetSubFolder (System::String subfolderName, bool ignoreCase) |
Gets the subfolder by name. More... | |
System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Email::Mapi::MapiMessage > > > | EnumerateMapiMessages () |
Exposes the enumerator, which supports an iteration of messages in folder. More... | |
System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< OlmMessageInfo > > > | EnumerateMessages () |
Exposes the enumerator, which supports an iteration of messages in folder. More... | |
System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< OlmMessageInfo > > > | EnumerateMessages (int32_t startIndex, int32_t count) |
Exposes the enumerator, which supports an iteration of messages in folder. More... | |
System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< OlmMessageInfo > > > | EnumerateMessages (System::SharedPtr< Aspose::Email::Tools::Search::MailQuery > query) |
Exposes the enumerator, which supports an iteration of messages in folder. More... | |
System::String | ToString () const override |
Returns a System::String that represents this instance. More... | |
Protected Member Functions | |
virtual | ~OlmFolder () |
Friends | |
class | Aspose::Email::Storage::Olm::OlmReader |
Represents folder information in OLM storage.
Aspose::Email::Storage::Olm::OlmFolder::OlmFolder | ( | System::String | fullPath, |
System::SharedPtr< OlmReader > | reader | ||
) |
Initializes a new instance of the OlmFolder class.
fullPath | The full path. |
|
protectedvirtual |
System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<Aspose::Email::Mapi::MapiMessage> > > Aspose::Email::Storage::Olm::OlmFolder::EnumerateMapiMessages | ( | ) |
Exposes the enumerator, which supports an iteration of messages in folder.
System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<OlmMessageInfo> > > Aspose::Email::Storage::Olm::OlmFolder::EnumerateMessages | ( | ) |
Exposes the enumerator, which supports an iteration of messages in folder.
System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<OlmMessageInfo> > > Aspose::Email::Storage::Olm::OlmFolder::EnumerateMessages | ( | int32_t | startIndex, |
int32_t | count | ||
) |
Exposes the enumerator, which supports an iteration of messages in folder.
startIndex | The start message index. |
count | The number of messages that will be retrieved. |
If "count" param is less than 0 or more than remained message count then remained message count will be returned.
ArgumentOutOfRangeException | throws, if startIndex less than 0. |
ArgumentOutOfRangeException | throws, if startIndex more or equal to total message count that folder contains. |
System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<OlmMessageInfo> > > Aspose::Email::Storage::Olm::OlmFolder::EnumerateMessages | ( | System::SharedPtr< Aspose::Email::Tools::Search::MailQuery > | query | ) |
Exposes the enumerator, which supports an iteration of messages in folder.
query | MailQuery that represents search query. |
int32_t Aspose::Email::Storage::Olm::OlmFolder::get_Depth | ( | ) | const |
Gets the depth.
The depth.
System::String Aspose::Email::Storage::Olm::OlmFolder::get_FullPath | ( | ) | const |
Gets the full path.
The full path.
bool Aspose::Email::Storage::Olm::OlmFolder::get_HasMessages | ( | ) |
Gets a value indicating whether the current folder has messages.
int32_t Aspose::Email::Storage::Olm::OlmFolder::get_MessageCount | ( | ) | const |
Gets the message count.
The message count.
System::String Aspose::Email::Storage::Olm::OlmFolder::get_Name | ( | ) | const |
Gets the folder name.
The name.
System::String Aspose::Email::Storage::Olm::OlmFolder::get_Path | ( | ) | const |
Gets the path.
The folder path.
System::SharedPtr<System::Collections::Generic::ListExt<System::SharedPtr<OlmFolder> > > Aspose::Email::Storage::Olm::OlmFolder::get_SubFolders | ( | ) | const |
Gets the list of sub-folders.
The list of sub-folders.
System::SharedPtr<OlmFolder> Aspose::Email::Storage::Olm::OlmFolder::GetSubFolder | ( | System::String | subfolderName, |
bool | ignoreCase | ||
) |
Gets the subfolder by name.
subfolderName | Name of subfolder. |
ignoreCase | A value that indicates whether the name to match is case insensitive. |
void Aspose::Email::Storage::Olm::OlmFolder::IncreaseMessageCount | ( | int32_t | count | ) |
Increases the message count.
|
override |
Returns a System::String that represents this instance.
|
friend |