Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder Class Referencefinal

Represents the builder of search expression based on the Advanced Query Syntax (AQS) that used by Exchange protocol. AQS is an alternative to search filters for expressing search criteria. More...

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

Public Member Functions

System::SharedPtr< Tools::Search::StringComparisonFieldget_Attachment () const
 Gets the field that allows to find items with a specified attachment name. More...
 
System::SharedPtr< Tools::Search::StringComparisonFieldget_Participants () const
 
System::SharedPtr< Tools::Search::StringComparisonFieldget_Category () const
 
System::SharedPtr< Tools::Search::StringComparisonFieldget_Importance () const
 
System::SharedPtr< Tools::Search::EnumComparisonFieldget_Kind () const
 
System::SharedPtr< Tools::Search::BoolComparisonFieldget_HasAttachment () const
 
System::SharedPtr< Tools::Search::BoolComparisonFieldget_Isflagged () const
 
System::SharedPtr< Tools::Search::BoolComparisonFieldget_IsRead () const
 
System::SharedPtr< Tools::Search::IntComparisonFieldget_Size () const
 
 ExchangeAdvancedSyntaxQueryBuilder ()
 
System::SharedPtr< Tools::Search::MailQueryOr (System::SharedPtr< Tools::Search::MailQuery > query1, System::SharedPtr< Tools::Search::MailQuery > query2)
 Search messages that match either search key. Provides disjunction between two expressions (OR). More...
 
System::SharedPtr< Tools::Search::MailQueryGetQuery ()
 Gets the query. 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 ~ExchangeAdvancedSyntaxQueryBuilder ()
 
- Protected Member Functions inherited from Aspose::Email::Tools::Search::MailQueryBuilder
virtual ~MailQueryBuilder ()
 

Detailed Description

Represents the builder of search expression based on the Advanced Query Syntax (AQS) that used by Exchange protocol. AQS is an alternative to search filters for expressing search criteria.

Constructor & Destructor Documentation

◆ ExchangeAdvancedSyntaxQueryBuilder()

Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::ExchangeAdvancedSyntaxQueryBuilder ( )

◆ ~ExchangeAdvancedSyntaxQueryBuilder()

virtual Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::~ExchangeAdvancedSyntaxQueryBuilder ( )
protectedvirtual

Member Function Documentation

◆ get_Attachment()

System::SharedPtr<Tools::Search::StringComparisonField> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::get_Attachment ( ) const

Gets the field that allows to find items with a specified attachment name.

◆ get_Category()

System::SharedPtr<Tools::Search::StringComparisonField> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::get_Category ( ) const

◆ get_HasAttachment()

System::SharedPtr<Tools::Search::BoolComparisonField> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::get_HasAttachment ( ) const

◆ get_Importance()

System::SharedPtr<Tools::Search::StringComparisonField> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::get_Importance ( ) const

◆ get_Isflagged()

System::SharedPtr<Tools::Search::BoolComparisonField> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::get_Isflagged ( ) const

◆ get_IsRead()

System::SharedPtr<Tools::Search::BoolComparisonField> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::get_IsRead ( ) const

◆ get_Kind()

System::SharedPtr<Tools::Search::EnumComparisonField> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::get_Kind ( ) const

◆ get_Participants()

System::SharedPtr<Tools::Search::StringComparisonField> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::get_Participants ( ) const

◆ get_Size()

System::SharedPtr<Tools::Search::IntComparisonField> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::get_Size ( ) const

◆ GetQuery()

System::SharedPtr<Tools::Search::MailQuery> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::GetQuery ( )

Gets the query.

Returns
MailQuery that represents search query.

◆ Or()

System::SharedPtr<Tools::Search::MailQuery> Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder::Or ( System::SharedPtr< Tools::Search::MailQuery query1,
System::SharedPtr< Tools::Search::MailQuery query2 
)

Search messages that match either search key. Provides disjunction between two expressions (OR).

Parameters
query1The query1.
query2The query2.
Returns
MailQuery that represents search query (one searching criterion).
Exceptions
ArgumentNullExceptionquery1 or query2