Represents the builder of search expression that used by IMAP protocol. More...

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

Public Member Functions
System::SharedPtr< Aspose::Email::Tools::Search::IntComparisonField >	get_MessageSize () const
	Gets messages with an specified size. More...

System::SharedPtr< SequenceSetField >	get_UniqueId () const
	Unique identifier More...

System::SharedPtr< ESearchOptions >	get_ESearchParameters () const
	Gets ESEARCH Parameters This method works only if server supports ESEARCH extension. Please, read more https://tools.ietf.org/html/rfc4315 More...

void	set_ESearchParameters (System::SharedPtr< ESearchOptions > value)
	Sets ESEARCH Parameters This method works only if server supports ESEARCH extension. Please, read more https://tools.ietf.org/html/rfc4315 More...

System::SharedPtr< ModificationSequenceField >	get_ModSeq () const
	Modification sequence More...

	ImapQueryBuilder (System::SharedPtr< System::Text::Encoding > defaultEncoding)
	Initializes a new instance of the ImapQueryBuilder class. More...

	ImapQueryBuilder ()
	Initializes a new instance of the ImapQueryBuilder class. More...

System::SharedPtr< Aspose::Email::Tools::Search::MailQuery >	HasFlags (System::SharedPtr< ImapMessageFlags > flags)
	Search messages with the specified flags. More...

System::SharedPtr< Aspose::Email::Tools::Search::MailQuery >	HasNoFlags (System::SharedPtr< ImapMessageFlags > flags)
	Search messages with the unspecified flags. More...

System::SharedPtr< Aspose::Email::Tools::Search::MailQuery >	HasHeader (System::String fieldName, System::String fieldValue)
	Search messages that have a header with the specified field-name and that contains the specified string in the text of the header (what comes after the colon). If the string to search is zero-length, this matches all messages that have a header line with the specified field-name regardless of the contents. More...

System::SharedPtr< Aspose::Email::Tools::Search::MailQuery >	CustomSearch (System::String fieldValue)
	Search messages according to extended server search syntax. More...

Public Member Functions inherited from Aspose::Email::Tools::Search::MailQueryBuilder
System::SharedPtr< StringComparisonField >	get_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< StringComparisonField >	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. More...

System::SharedPtr< StringComparisonField >	get_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< StringComparisonField >	get_Body () const
	Gets the field that allows to find messages that contain the specified string in the body of the message. More...

System::SharedPtr< StringComparisonField >	get_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< StringComparisonField >	get_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< StringComparisonField >	get_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< DateComparisonField >	get_InternalDate () const
	Gets the field that allows to find messages by internal date. More...

System::SharedPtr< DateComparisonField >	get_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< MailQuery >	Or (System::SharedPtr< MailQuery > query1, System::SharedPtr< MailQuery > query2)
	Search messages that match either search key. Provides disjunction between two expressions (OR). More...

System::SharedPtr< MailQuery >	GetQuery ()
	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	~ImapQueryBuilder ()

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

Detailed Description

Represents the builder of search expression that used by IMAP protocol.

Constructor & Destructor Documentation

◆ ImapQueryBuilder() [1/2]

Aspose::Email::Clients::Imap::ImapQueryBuilder::ImapQueryBuilder ( System::SharedPtr< System::Text::Encoding > defaultEncoding )

Initializes a new instance of the ImapQueryBuilder class.

Parameters

defaultEncoding Contains default encoding (charset) for query builder.

◆ ImapQueryBuilder() [2/2]

Aspose::Email::Clients::Imap::ImapQueryBuilder::ImapQueryBuilder ( )

Initializes a new instance of the ImapQueryBuilder class.

◆ ~ImapQueryBuilder()

virtual Aspose::Email::Clients::Imap::ImapQueryBuilder::~ImapQueryBuilder ( )

protectedvirtual

Member Function Documentation

◆ CustomSearch()

System::SharedPtr<Aspose::Email::Tools::Search::MailQuery> Aspose::Email::Clients::Imap::ImapQueryBuilder::CustomSearch ( System::String fieldValue )

Search messages according to extended server search syntax.

Parameters

fieldValue The field value.

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

◆ get_ESearchParameters()

System::SharedPtr<ESearchOptions> Aspose::Email::Clients::Imap::ImapQueryBuilder::get_ESearchParameters ( ) const

Gets ESEARCH Parameters This method works only if server supports ESEARCH extension. Please, read more https://tools.ietf.org/html/rfc4315

◆ get_MessageSize()

System::SharedPtr<Aspose::Email::Tools::Search::IntComparisonField> Aspose::Email::Clients::Imap::ImapQueryBuilder::get_MessageSize ( ) const

Gets messages with an specified size.

The IntComparisonField that represents a message size.

◆ get_ModSeq()

System::SharedPtr<ModificationSequenceField> Aspose::Email::Clients::Imap::ImapQueryBuilder::get_ModSeq ( ) const

Modification sequence

◆ get_UniqueId()

System::SharedPtr<SequenceSetField> Aspose::Email::Clients::Imap::ImapQueryBuilder::get_UniqueId ( ) const

Unique identifier

◆ HasFlags()

System::SharedPtr<Aspose::Email::Tools::Search::MailQuery> Aspose::Email::Clients::Imap::ImapQueryBuilder::HasFlags ( System::SharedPtr< ImapMessageFlags > flags )

Search messages with the specified flags.

Parameters

flags The flags.

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

◆ HasHeader()

System::SharedPtr<Aspose::Email::Tools::Search::MailQuery> Aspose::Email::Clients::Imap::ImapQueryBuilder::HasHeader	(	System::String	fieldName,
		System::String	fieldValue
	)

Search messages that have a header with the specified field-name and that contains the specified string in the text of the header (what comes after the colon). If the string to search is zero-length, this matches all messages that have a header line with the specified field-name regardless of the contents.

Parameters

fieldName	Name of the field.
fieldValue	The field value.

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

◆ HasNoFlags()

System::SharedPtr<Aspose::Email::Tools::Search::MailQuery> Aspose::Email::Clients::Imap::ImapQueryBuilder::HasNoFlags ( System::SharedPtr< ImapMessageFlags > flags )

Search messages with the unspecified flags.

Parameters

flags The flags.

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

◆ set_ESearchParameters()

void Aspose::Email::Clients::Imap::ImapQueryBuilder::set_ESearchParameters ( System::SharedPtr< ESearchOptions > value )

Sets ESEARCH Parameters This method works only if server supports ESEARCH extension. Please, read more https://tools.ietf.org/html/rfc4315

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ImapQueryBuilder() [1/2]

◆ ImapQueryBuilder() [2/2]

◆ ~ImapQueryBuilder()

Member Function Documentation

◆ CustomSearch()

◆ get_ESearchParameters()

◆ get_MessageSize()

◆ get_ModSeq()

◆ get_UniqueId()

◆ HasFlags()

◆ HasHeader()

◆ HasNoFlags()

◆ set_ESearchParameters()