Aspose::Email::Clients::Imap::SortConditions Class Referencefinal

Provides the search conditions for the SORT extension. Compatibles with SORT IMAP extension described at https://tools.ietf.org/html/rfc5256 More...

Inherits Aspose::Email::Clients::Imap::BaseSearchConditions.

Public Member Functions

SortingKey get_SortBy () const
 Gets sort criteria More...
 
void set_SortBy (SortingKey value)
 Sets sort criteria More...
 
SortingKey get_ReverseBy () const
 Gets reverse sort criteria Followed by another sort criterion, has the effect of that criterion but in reverse(descending) order. Note: REVERSE only reverses a single criterion, and does not affect the implicit "sequence number" sort criterion if all other criteria are identical. Consequently, a sort of REVERSE SUBJECT is not the same as a reverse ordering of a SUBJECT sort. This can be avoided by use of additional criteria, e.g., SUBJECT DATE vs. REVERSE SUBJECT REVERSE DATE.
In general, however, it's better (and faster, if the client has a "reverse current ordering" command) to reverse the results in the client instead of issuing a new SORT. More...
 
void set_ReverseBy (SortingKey value)
 Sets reverse sort criteria Followed by another sort criterion, has the effect of that criterion but in reverse(descending) order. Note: REVERSE only reverses a single criterion, and does not affect the implicit "sequence number" sort criterion if all other criteria are identical. Consequently, a sort of REVERSE SUBJECT is not the same as a reverse ordering of a SUBJECT sort. This can be avoided by use of additional criteria, e.g., SUBJECT DATE vs. REVERSE SUBJECT REVERSE DATE.
In general, however, it's better (and faster, if the client has a "reverse current ordering" command) to reverse the results in the client instead of issuing a new SORT. More...
 
 SortConditions ()
 
- Public Member Functions inherited from Aspose::Email::Clients::Imap::BaseSearchConditions
bool get_UseUId () const
 Gets a value indicating whether the search method returns sequence numbers or UIDs of messages. More...
 
void set_UseUId (bool value)
 Sets a value indicating whether the search method returns sequence numbers or UIDs of messages. More...
 
System::String get_Charset () const
 Gets charset. Indicates the charset of the strings that appear in the searching criteria. More...
 
void set_Charset (System::String value)
 Sets charset. Indicates the charset of the strings that appear in the searching criteria. More...
 
System::String get_Text () const
 Gets subject text. More...
 
void set_Text (System::String value)
 Sets subject text. More...
 
System::Nullable< System::DateTime > get_Since () const
 Gets the message date since which the search criteria matches. More...
 
void set_Since (System::Nullable< System::DateTime > value)
 Sets the message date since which the search criteria matches. More...
 
 BaseSearchConditions ()
 

Detailed Description

Provides the search conditions for the SORT extension. Compatibles with SORT IMAP extension described at https://tools.ietf.org/html/rfc5256

Constructor & Destructor Documentation

◆ SortConditions()

Aspose::Email::Clients::Imap::SortConditions::SortConditions ( )

Member Function Documentation

◆ get_ReverseBy()

SortingKey Aspose::Email::Clients::Imap::SortConditions::get_ReverseBy ( ) const

Gets reverse sort criteria Followed by another sort criterion, has the effect of that criterion but in reverse(descending) order. Note: REVERSE only reverses a single criterion, and does not affect the implicit "sequence number" sort criterion if all other criteria are identical. Consequently, a sort of REVERSE SUBJECT is not the same as a reverse ordering of a SUBJECT sort. This can be avoided by use of additional criteria, e.g., SUBJECT DATE vs. REVERSE SUBJECT REVERSE DATE.
In general, however, it's better (and faster, if the client has a "reverse current ordering" command) to reverse the results in the client instead of issuing a new SORT.

◆ get_SortBy()

SortingKey Aspose::Email::Clients::Imap::SortConditions::get_SortBy ( ) const

Gets sort criteria

◆ set_ReverseBy()

void Aspose::Email::Clients::Imap::SortConditions::set_ReverseBy ( SortingKey  value)

Sets reverse sort criteria Followed by another sort criterion, has the effect of that criterion but in reverse(descending) order. Note: REVERSE only reverses a single criterion, and does not affect the implicit "sequence number" sort criterion if all other criteria are identical. Consequently, a sort of REVERSE SUBJECT is not the same as a reverse ordering of a SUBJECT sort. This can be avoided by use of additional criteria, e.g., SUBJECT DATE vs. REVERSE SUBJECT REVERSE DATE.
In general, however, it's better (and faster, if the client has a "reverse current ordering" command) to reverse the results in the client instead of issuing a new SORT.

◆ set_SortBy()

void Aspose::Email::Clients::Imap::SortConditions::set_SortBy ( SortingKey  value)

Sets sort criteria