Imap FolderSort(Search Options, Search Query, IListOrder By, Cancellation Token) Method
Sort messages matching the specified query.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The search results.
IMailFolderSort(SearchOptions, SearchQuery, IListOrderBy, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override 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
SearchResultsThe search results.
Implements
IMailFolderSort(SearchOptions, SearchQuery, IListOrderBy, CancellationToken)IMailFolderSort(SearchOptions, SearchQuery, IListOrderBy, CancellationToken)
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 by the IMAP server. -or- The IMAP server does not support the ESORT 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. |