MailFolderSearch(IListUniqueId, SearchQuery, CancellationToken) Method

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

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1

Syntax

public virtual IList<UniqueId> Search(
	IList<UniqueId> uids,
	SearchQuery query,
	CancellationToken cancellationToken = default
)

IListUniqueId
An array of matching UIDs in the specified sort order.

Exceptions

Exception	Condition
ArgumentNullException	uids is null. -or- query is null.
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.

Remarks

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