Click or drag to resize
MimeKit

IImapFolderSearchAsync(String, CancellationToken) Method

Asynchronously search the folder for messages matching the specified query.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
Task<SearchResults> SearchAsync(
	string query,
	CancellationToken cancellationToken = default
)

Parameters

query  String
The search query.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskSearchResults
An array of matching UIDs.
Exceptions
ExceptionCondition
ArgumentNullExceptionquery is null.
ArgumentExceptionquery is an empty string.
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
Sends a UID SEARCH command with the specified query passed directly to the IMAP server with no interpretation by MailKit. This means that the query may contain any arguments that a UID SEARCH command is allowed to have according to the IMAP specifications and any extensions that are supported, including RETURN parameters.
See Also