IMailFolderSearchAsync(SearchOptions, SearchQuery, CancellationToken) Method

Asynchronously search the folder for messages matching the specified query.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
Task<SearchResults> SearchAsync(
	SearchOptions options,
	SearchQuery query,
	CancellationToken cancellationToken = default
)

Parameters

options  SearchOptions
The search options.
query  SearchQuery
The search query.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskSearchResults
The search results.

Remarks

Asynchronously searches the folder for messages matching the specified query, returning only the specified search results.

Exceptions

ArgumentNullException query is .
NotSupportedException

One or more search terms in the query are not supported.

-or-

The server does not support the specified search options.
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.

See Also