Click or drag to resize
MimeKit

ImapFolderThreadAsync(ThreadingAlgorithm, SearchQuery, CancellationToken) Method

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

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public override 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)
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 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.
Remarks
See Also