Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder Class Referencefinal

Represents the builder of search expression that used by pst. More...

Inherits Aspose::Email::Tools::Search::MailQueryBuilder.

Public Member Functions

System::SharedPtr< Aspose::Email::Tools::Search::BoolComparisonFieldget_OnlyFoldersCreatedByUser () const
 Gets folders that created by user, i.e. excludes all standard IPM folders. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::StringComparisonFieldget_MessageId () const
 Gets the field that allows to find messages that contain the specified string in the envelope structure's MessageId field. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::StringComparisonFieldget_MessageClass () const
 Gets messages with an specified message class. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::IntComparisonFieldget_MessageSize () const
 Search messages with an specified size. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::IntComparisonFieldget_Importance () const
 Search messages with an specified importance. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::StringComparisonFieldget_ContainerClass () const
 Gets folders with an specified message class. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::StringComparisonFieldget_FolderName () const
 Search folders with an specified display name. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::IntComparisonFieldget_ContentsCount () const
 Search folders with an specified contents count. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::IntComparisonFieldget_UnreadContentsCount () const
 Search folders with an specified unread contents count. More...
 
 PersonalStorageQueryBuilder ()
 Initializes a new instance of the PersonalStorageQueryBuilder class. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::MailQueryFindConversationThread (System::SharedPtr< MessageInfo > relatedMessage)
 Finds the conversation thread. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::MailQueryHasFlags (Aspose::Email::Mapi::MapiMessageFlags flags)
 Search messages with the specified flags. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::MailQueryHasNoFlags (Aspose::Email::Mapi::MapiMessageFlags flags)
 Search messages with the unspecified flags. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::MailQueryHasSubfolders ()
 Search folders which contains subfolders. More...
 
System::SharedPtr< Aspose::Email::Tools::Search::MailQueryHasNoSubfolders ()
 Search folders which does not contains subfolders. More...
 
- Public Member Functions inherited from Aspose::Email::Tools::Search::MailQueryBuilder
System::SharedPtr< StringComparisonFieldget_To () const
 Gets the field that allows to find messages that contain the specified string in the envelope structure's TO field. More...
 
System::SharedPtr< StringComparisonFieldget_Text () const
 Gets the field that allows to find the messages that contain the specified string in the headers (subject, from, to, cc) and body of the message. More...
 
System::SharedPtr< StringComparisonFieldget_Bcc () const
 Gets the field that allows to find messages that contain the specified string in the envelope structure's BCC field. More...
 
System::SharedPtr< StringComparisonFieldget_Body () const
 Gets the field that allows to find messages that contain the specified string in the body of the message. More...
 
System::SharedPtr< StringComparisonFieldget_Cc () const
 Gets the field that allows to find messages that contain the specified string in the envelope structure's CC field. More...
 
System::SharedPtr< StringComparisonFieldget_From () const
 Gets the field that allows to find messages that contain the specified string in the envelope structure's FROM field. More...
 
System::SharedPtr< StringComparisonFieldget_Subject () const
 Gets the field that allows to find messages that contain the specified string in the envelope structure's SUBJECT field. More...
 
System::SharedPtr< System::Text::Encoding > get_DefaultEncoding () const
 Gets default encoding (charset) for query builder More...
 
System::SharedPtr< DateComparisonFieldget_InternalDate () const
 Gets the field that allows to find messages by internal date. More...
 
System::SharedPtr< DateComparisonFieldget_SentDate () const
 Gets the field that allows to find messages by sent date. More...
 
System::SharedPtr< System::Collections::Generic::ListExt< System::SharedPtr< MailQuery > > > get_KeyCollection () const
 Gets the key collection. More...
 
System::SharedPtr< System::Collections::Generic::ListExt< System::SharedPtr< MailQuery > > > get_OrderByCollection () const
 Gets the key collection. More...
 
 MailQueryBuilder ()
 Initializes a new instance of the MailQueryBuilder class. More...
 
 MailQueryBuilder (System::SharedPtr< System::Text::Encoding > defaultEncoding)
 Initializes a new instance of the MailQueryBuilder class. More...
 
System::SharedPtr< MailQueryOr (System::SharedPtr< MailQuery > query1, System::SharedPtr< MailQuery > query2)
 Search messages that match either search key. Provides disjunction between two expressions (OR). More...
 
System::SharedPtr< MailQueryGetQuery ()
 Gets the query. More...
 
System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::SharedPtr< System::Object > > > GetOptions ()
 
void Clear ()
 Clears query. More...
 

Protected Member Functions

virtual ~PersonalStorageQueryBuilder ()
 
- Protected Member Functions inherited from Aspose::Email::Tools::Search::MailQueryBuilder
virtual ~MailQueryBuilder ()
 

Detailed Description

Represents the builder of search expression that used by pst.

Constructor & Destructor Documentation

◆ PersonalStorageQueryBuilder()

Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::PersonalStorageQueryBuilder ( )

Initializes a new instance of the PersonalStorageQueryBuilder class.

◆ ~PersonalStorageQueryBuilder()

virtual Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::~PersonalStorageQueryBuilder ( )
protectedvirtual

Member Function Documentation

◆ FindConversationThread()

System::SharedPtr<Aspose::Email::Tools::Search::MailQuery> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::FindConversationThread ( System::SharedPtr< MessageInfo relatedMessage)

Finds the conversation thread.

Parameters
relatedMessageThe related message.
Returns

◆ get_ContainerClass()

System::SharedPtr<Aspose::Email::Tools::Search::StringComparisonField> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::get_ContainerClass ( ) const

Gets folders with an specified message class.

The StringComparisonField that represents a container class.

◆ get_ContentsCount()

System::SharedPtr<Aspose::Email::Tools::Search::IntComparisonField> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::get_ContentsCount ( ) const

Search folders with an specified contents count.

◆ get_FolderName()

System::SharedPtr<Aspose::Email::Tools::Search::StringComparisonField> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::get_FolderName ( ) const

Search folders with an specified display name.

◆ get_Importance()

System::SharedPtr<Aspose::Email::Tools::Search::IntComparisonField> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::get_Importance ( ) const

Search messages with an specified importance.

◆ get_MessageClass()

System::SharedPtr<Aspose::Email::Tools::Search::StringComparisonField> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::get_MessageClass ( ) const

Gets messages with an specified message class.

The StringComparisonField that represents a message class.

◆ get_MessageId()

System::SharedPtr<Aspose::Email::Tools::Search::StringComparisonField> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::get_MessageId ( ) const

Gets the field that allows to find messages that contain the specified string in the envelope structure's MessageId field.

The DateComparisonField that represents MessageId search field.

◆ get_MessageSize()

System::SharedPtr<Aspose::Email::Tools::Search::IntComparisonField> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::get_MessageSize ( ) const

Search messages with an specified size.

◆ get_OnlyFoldersCreatedByUser()

System::SharedPtr<Aspose::Email::Tools::Search::BoolComparisonField> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::get_OnlyFoldersCreatedByUser ( ) const

Gets folders that created by user, i.e. excludes all standard IPM folders.

TheBoolComparisonField that represents search field.

◆ get_UnreadContentsCount()

System::SharedPtr<Aspose::Email::Tools::Search::IntComparisonField> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::get_UnreadContentsCount ( ) const

Search folders with an specified unread contents count.

◆ HasFlags()

System::SharedPtr<Aspose::Email::Tools::Search::MailQuery> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::HasFlags ( Aspose::Email::Mapi::MapiMessageFlags  flags)

Search messages with the specified flags.

Parameters
flagsThe flags.
Returns
MailQuery that represents search query (one searching criteria).

◆ HasNoFlags()

System::SharedPtr<Aspose::Email::Tools::Search::MailQuery> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::HasNoFlags ( Aspose::Email::Mapi::MapiMessageFlags  flags)

Search messages with the unspecified flags.

Parameters
flagsThe flags.
Returns
MailQuery that represents search query (one searching criteria).

◆ HasNoSubfolders()

System::SharedPtr<Aspose::Email::Tools::Search::MailQuery> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::HasNoSubfolders ( )

Search folders which does not contains subfolders.

Returns
MailQuery that represents search query (one searching criteria).

◆ HasSubfolders()

System::SharedPtr<Aspose::Email::Tools::Search::MailQuery> Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder::HasSubfolders ( )

Search folders which contains subfolders.

Returns
MailQuery that represents search query (one searching criteria).