Click or drag to resize
MimeKit

MailFolderThreadAsync(ThreadingAlgorithm, SearchQuery, CancellationToken) Method

Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public abstract 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

TaskIListMessageThread
An array of message threads.

Implements

IMailFolderThreadAsync(ThreadingAlgorithm, SearchQuery, CancellationToken)
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionalgorithm is not supported.
ArgumentNullExceptionquery is null.
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.
Remarks
See Also