ImapFolderSort(SearchOptions, SearchQuery, IListOrderBy, PartialRange, CancellationToken) Method

Sort messages matching the specified query, returning only the specified range of results.

Definition

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override 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

SearchResults
The search results.

Implements

IMailFolderSort(SearchOptions, SearchQuery, IListOrderBy, PartialRange, CancellationToken)
IMailFolderSort(SearchOptions, SearchQuery, IListOrderBy, PartialRange, CancellationToken)

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.

  Note

If the range specified by partialRange references results beyond the end of the complete set of matching messages, then the results will only contain the unique identifiers that fall within the range (if any).

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 by the IMAP server.

-or-

The IMAP server does not support the ESORT extension.

-or-

The IMAP server does not support the PARTIAL 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.

See Also