IMailFolderSort(SearchOptions, SearchQuery, IListOrderBy, CancellationToken) Method

Sort messages matching the specified query.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
SearchResults Sort(
	SearchOptions options,
	SearchQuery query,
	IList<OrderBy> orderBy,
	CancellationToken cancellationToken = default
)

Parameters

options  SearchOptions
The search options.
query  SearchQuery
The search query.
orderBy  IListOrderBy
The sort order.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

SearchResults
The search results.

Remarks

Searches the folder for messages matching the specified query, returning the search results in the specified sort order.

Exceptions

ArgumentNullException

query is .

-or-

orderBy is .
ArgumentException orderBy is empty.
NotSupportedException

One or more search terms in the query are not supported.

-or-

The server does not support the specified search options.

-or-

The server does not support sorting search results.
ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore is not authenticated.
FolderNotOpenException The MailFolder is not currently open.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
ProtocolException The server's response contained unexpected tokens.
CommandException The command failed.

See Also