Click or drag to resize
MimeKit

MailFolderSearch(SearchQuery, CancellationToken) Method

Search the folder for messages matching the specified query.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public virtual IList<UniqueId> Search(
	SearchQuery query,
	CancellationToken cancellationToken = default
)

Parameters

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

Return Value

IListUniqueId
An array of matching UIDs.

Implements

IMailFolderSearch(SearchQuery, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullExceptionquery is null.
NotSupportedException One or more search terms in the query are not supported by the mail store.
ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore is not authenticated.
FolderNotOpenException The folder 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
The returned array of unique identifiers can be used with methods such as GetMessage(UniqueId, CancellationToken, ITransferProgress).
See Also