IMail FolderSort(Search Options, Search Query, IListOrder By, Partial Range, Cancellation Token) Method
Definition
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
SearchResults Sort(
SearchOptions options,
SearchQuery query,
IList<OrderBy> orderBy,
PartialRange partialRange,
CancellationToken cancellationToken = default
)Parameters
- options SearchOptions
- The search options.
- query SearchQuery
- The search query.
- orderBy IListOrderBy
- The sort order.
- partialRange PartialRange
- The partial range of search results to return.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
SearchResultsThe search results.
Remarks
Searches the folder for messages matching the specified query, returning only the search results within the specified range in the specified sort order.
Positive positions within the partialRange range are relative to the first result in the sort order while negative positions are relative to the last result. For example, a range of 1:50 will return the first 50 results in the specified sort order.
Exceptions
| ArgumentException |
options contains the All flag, which cannot be combined with a partial range. -or- orderBy is empty. |
| ArgumentNullException |
query is . -or- orderBy is . |
| NotSupportedException |
One or more search terms in the query are not supported. -or- The server does not support the specified search options. -or- The folder does not support partial sorts. |
| ObjectDisposedException | The IMailStore has been disposed. |
| ServiceNotConnectedException | The IMailStore is not connected. |
| ServiceNotAuthenticatedException | The IMailStore is not authenticated. |
| FolderNotOpenException | The MailFolder 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. |