IMail
Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
Definition
Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
An array of message threads.
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
Task<IList<MessageThread>> ThreadAsync(
ThreadingAlgorithm algorithm,
SearchQuery query,
CancellationToken cancellationToken = default
)Parameters
- 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.
Remarks
The UniqueId can be used with methods such as
GetMessage(UniqueId, CancellationToken, ITransferProgress).
Exceptions
| ArgumentOutOfRangeException | algorithm is not supported. |
| ArgumentNullException | query is . |
| NotSupportedException |
One or more search terms in the query are not supported. -or- The server does not support threading search results. |
| 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. |