ImapFolderSortAsync(SearchQuery, IListOrderBy, CancellationToken) Method

Asynchronously sort messages matching the specified query.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.3.0

Syntax

public override Task<IList<UniqueId>> SortAsync(
	SearchQuery query,
	IList<OrderBy> orderBy,
	CancellationToken cancellationToken = default
)

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

Exceptions

Exception	Condition
ArgumentNullException	query is null. -or- orderBy is null.
ArgumentException	orderBy is empty.
NotSupportedException	One or more search terms in the query are not supported by the IMAP server. -or- The server does not support the SORT extension.
ObjectDisposedException	The ImapClient has been disposed.
ServiceNotConnectedException	The ImapClient is not connected.
ServiceNotAuthenticatedException	The ImapClient is not authenticated.
FolderNotOpenException	The ImapFolder is not currently open.
OperationCanceledException	The operation was canceled via the cancellation token.
IOException	An I/O error occurred.
ImapProtocolException	The server's response contained unexpected tokens.
ImapCommandException	The server replied with a NO or BAD response.

Remarks

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