IMailFolderSortAsync(SearchOptions, IListUniqueId, SearchQuery, IListOrderBy, CancellationToken) Method

Asynchronously sort messages matching the specified query.

Definition

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

Parameters

options  SearchOptions
The search options.
uids  IListUniqueId
The subset of UIDs
query  SearchQuery
The search query.
orderBy  IListOrderBy
The sort order.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskSearchResults
The search results.

Remarks

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

Exceptions

ArgumentNullException

uids is .

-or-

query is .

-or-

orderBy is .
ArgumentException

uids is empty.

-or-

One or more of the uids is invalid.

-or-

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 folder 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