IMailFolderSort(SearchQuery, IListOrderBy, CancellationToken) Method

Sort messages matching the specified query.

Definition

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

Parameters

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

Return Value

IListUniqueId
An array of matching UIDs in the specified sort order.

Remarks

The returned array of unique identifiers will be sorted in the preferred order and can be used with GetMessage(UniqueId, CancellationToken, ITransferProgress).

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