Imap FolderSearch(Search Options, Search Query, Cancellation Token) Method
Search the folder for messages matching the specified query.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The search results.
IMailFolderSearch(SearchOptions, SearchQuery, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override SearchResults Search(
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
SearchResultsThe search results.
Implements
IMailFolderSearch(SearchOptions, SearchQuery, CancellationToken)IMailFolderSearch(SearchOptions, SearchQuery, CancellationToken)
Remarks
Searches the folder for messages matching the specified query,
returning only the specified search results.
Exceptions
| ArgumentNullException | query is . |
| 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. |