Aspose::Email::Tools::Search::MailQueryBuilder Class Reference

Represents the builder of search expression. More...

Inherits Object.

Inherited by Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder, Aspose::Email::Clients::Exchange::ExchangeQueryBuilder, Aspose::Email::Clients::Imap::ImapQueryBuilder, and Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder.

Public Member Functions

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 ~MailQueryBuilder ()
 

Friends

class Aspose::Email::Tools::Search::ComparisonField
 
class Aspose::Email::Clients::Exchange::AppointmentQueryBuilder
 
class Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder
 
class Aspose::Email::Clients::Imap::ESearchOptions
 
class Aspose::Email::Clients::Imap::ModificationSequenceField
 
class Aspose::Email::Clients::Imap::SequenceSetField
 
class Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder
 
class Aspose::Email::Tools::Search::EnumComparisonField
 
class Aspose::Email::Tools::Search::StringComparisonField
 

Detailed Description

Represents the builder of search expression.

Note: By default, the result is the intersection (AND function) of all the messages that match those keys. To join keys by OR function, please, use Or() method of this class

Constructor & Destructor Documentation

◆ MailQueryBuilder() [1/2]

Aspose::Email::Tools::Search::MailQueryBuilder::MailQueryBuilder ( )

Initializes a new instance of the MailQueryBuilder class.

◆ MailQueryBuilder() [2/2]

Aspose::Email::Tools::Search::MailQueryBuilder::MailQueryBuilder ( System::SharedPtr< System::Text::Encoding >  defaultEncoding)

Initializes a new instance of the MailQueryBuilder class.

Parameters
defaultEncodingContains default encoding (charset) for query builder.

◆ ~MailQueryBuilder()

virtual Aspose::Email::Tools::Search::MailQueryBuilder::~MailQueryBuilder ( )
protectedvirtual

Member Function Documentation

◆ Clear()

void Aspose::Email::Tools::Search::MailQueryBuilder::Clear ( )

Clears query.

◆ get_Bcc()

System::SharedPtr<StringComparisonField> Aspose::Email::Tools::Search::MailQueryBuilder::get_Bcc ( ) const

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

The DateComparisonField that represents BCC search field.

◆ get_Body()

System::SharedPtr<StringComparisonField> Aspose::Email::Tools::Search::MailQueryBuilder::get_Body ( ) const

Gets the field that allows to find messages that contain the specified string in the body of the message.

The DateComparisonField that represents body search field.

◆ get_Cc()

System::SharedPtr<StringComparisonField> Aspose::Email::Tools::Search::MailQueryBuilder::get_Cc ( ) const

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

The DateComparisonField that represents cc search field.

◆ get_DefaultEncoding()

System::SharedPtr<System::Text::Encoding> Aspose::Email::Tools::Search::MailQueryBuilder::get_DefaultEncoding ( ) const

Gets default encoding (charset) for query builder

◆ get_From()

System::SharedPtr<StringComparisonField> Aspose::Email::Tools::Search::MailQueryBuilder::get_From ( ) const

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

The DateComparisonField that represents from search field.

◆ get_InternalDate()

System::SharedPtr<DateComparisonField> Aspose::Email::Tools::Search::MailQueryBuilder::get_InternalDate ( ) const

Gets the field that allows to find messages by internal date.

The DateComparisonField that represents internal date search field.

◆ get_KeyCollection()

System::SharedPtr<System::Collections::Generic::ListExt<System::SharedPtr<MailQuery> > > Aspose::Email::Tools::Search::MailQueryBuilder::get_KeyCollection ( ) const

Gets the key collection.

The key collection.

◆ get_OrderByCollection()

System::SharedPtr<System::Collections::Generic::ListExt<System::SharedPtr<MailQuery> > > Aspose::Email::Tools::Search::MailQueryBuilder::get_OrderByCollection ( ) const

Gets the key collection.

The key collection.

◆ get_SentDate()

System::SharedPtr<DateComparisonField> Aspose::Email::Tools::Search::MailQueryBuilder::get_SentDate ( ) const

Gets the field that allows to find messages by sent date.

The DateComparisonField that represents sent date search field.

◆ get_Subject()

System::SharedPtr<StringComparisonField> Aspose::Email::Tools::Search::MailQueryBuilder::get_Subject ( ) const

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

The DateComparisonField that represents subject search field.

◆ get_Text()

System::SharedPtr<StringComparisonField> Aspose::Email::Tools::Search::MailQueryBuilder::get_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.

The DateComparisonField that represents text header or body search fields.

◆ get_To()

System::SharedPtr<StringComparisonField> Aspose::Email::Tools::Search::MailQueryBuilder::get_To ( ) const

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

The DateComparisonField that represents TO search field.

◆ GetOptions()

System::SharedPtr<System::Collections::Generic::Dictionary<System::String, System::SharedPtr<System::Object> > > Aspose::Email::Tools::Search::MailQueryBuilder::GetOptions ( )

◆ GetQuery()

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::MailQueryBuilder::GetQuery ( )

Gets the query.

Returns
MailQuery that represents search query.

◆ Or()

System::SharedPtr<MailQuery> Aspose::Email::Tools::Search::MailQueryBuilder::Or ( System::SharedPtr< MailQuery query1,
System::SharedPtr< 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).

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::AppointmentQueryBuilder

◆ Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxQueryBuilder

◆ Aspose::Email::Clients::Imap::ESearchOptions

◆ Aspose::Email::Clients::Imap::ModificationSequenceField

◆ Aspose::Email::Clients::Imap::SequenceSetField

◆ Aspose::Email::Storage::Pst::PersonalStorageQueryBuilder

◆ Aspose::Email::Tools::Search::ComparisonField

◆ Aspose::Email::Tools::Search::EnumComparisonField

◆ Aspose::Email::Tools::Search::StringComparisonField