Click or drag to resize
MimeKit

MailFolderSearchAsync(SearchOptions, SearchQuery, CancellationToken) Method

Asynchronously search the folder for messages matching the specified query.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
Copy
public abstract 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.

Implements

IMailFolderSearchAsync(SearchOptions, SearchQuery, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullExceptionquery is null.
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.
Remarks
Asynchronously searches the folder for messages matching the specified query, returning only the specified search results.
See Also