IMailFolderSearchAsync(IListUniqueId, SearchQuery, CancellationToken) Method

Asynchronously search the subset of UIDs in the folder for messages matching the specified query.

Definition

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

Parameters

uids  IListUniqueId
The subset of UIDs
query  SearchQuery
The search query.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskIListUniqueId
An array of matching UIDs.

Remarks

The returned array of unique identifiers can be used with methods such as GetMessage(UniqueId, CancellationToken, ITransferProgress).

Exceptions

ArgumentNullException

uids is .

-or-

query is .
ArgumentException

uids is empty.

-or-

One or more of the uids is invalid.
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.

See Also