Click or drag to resize
MimeKit

ImapFolderSearchAsync(SearchOptions, SearchQuery, CancellationToken) Method

Asynchronously search the folder for messages matching the specified query.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
public override 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)
IMailFolderSearchAsync(SearchOptions, SearchQuery, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullExceptionquery is null.
NotSupportedException

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

-or-

The IMAP server does not support the ESEARCH 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.
Remarks
Searches the folder for messages matching the specified query, returning only the specified search results.
See Also