Imap FolderThread Async(IListUnique Id, Threading Algorithm, Search Query, Cancellation Token) Method
Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
An array of message threads.
IMailFolderThreadAsync(IListUniqueId, ThreadingAlgorithm, SearchQuery, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task<IList<MessageThread>> ThreadAsync(
IList<UniqueId> uids,
ThreadingAlgorithm algorithm,
SearchQuery query,
CancellationToken cancellationToken = default
)Parameters
- uids IListUniqueId
- The subset of UIDs
- algorithm ThreadingAlgorithm
- The threading algorithm to use.
- query SearchQuery
- The search query.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskIListMessageThreadAn array of message threads.
Implements
IMailFolderThreadAsync(IListUniqueId, ThreadingAlgorithm, SearchQuery, CancellationToken)IMailFolderThreadAsync(IListUniqueId, ThreadingAlgorithm, SearchQuery, CancellationToken)
Remarks
The UniqueId can be used with methods such as
GetMessage(UniqueId, CancellationToken, ITransferProgress).
Exceptions
| ArgumentOutOfRangeException | algorithm is not supported. |
| 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 IMAP server. -or- The server does not support the THREAD 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. |