Imap FolderSort Async(Search Query, IListOrder By, Cancellation Token) Method
Asynchronously sort messages matching the specified query.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
An array of matching UIDs in the specified sort order.
IMailFolderSortAsync(SearchQuery, IListOrderBy, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task<IList<UniqueId>> SortAsync(
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
TaskIListUniqueIdAn array of matching UIDs in the specified sort order.
Implements
IMailFolderSortAsync(SearchQuery, IListOrderBy, CancellationToken)IMailFolderSortAsync(SearchQuery, IListOrderBy, CancellationToken)
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 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. |