Imap FolderSearch Async(Search Options, Search Query, Partial Range, Cancellation Token) Method
Asynchronously search the folder for messages matching the specified query, returning only the specified range of results.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The search results.
IMailFolderSearchAsync(SearchOptions, SearchQuery, PartialRange, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task<SearchResults> SearchAsync(
SearchOptions options,
SearchQuery query,
PartialRange partialRange,
CancellationToken cancellationToken = default
)Parameters
- options SearchOptions
- The search options.
- query SearchQuery
- The search query.
- partialRange PartialRange
- The partial range of search results to return.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskSearchResultsThe search results.
Implements
IMailFolderSearchAsync(SearchOptions, SearchQuery, PartialRange, CancellationToken)IMailFolderSearchAsync(SearchOptions, SearchQuery, PartialRange, CancellationToken)
Remarks
Asynchronously searches the folder for messages matching the specified query, returning only the search results within the specified range.
Positive positions within the partialRange range are relative to the oldest matching message while negative positions are relative to the newest matching message. For example, a range of 1:500 will return the oldest 500 results while a range of -1:-500 will return the newest 500 results.
Exceptions
| ArgumentException | options contains the All flag, which cannot be combined with a partial range. |
| 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. -or- The IMAP server does not support the PARTIAL 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. |