Click or drag to resize
MimeKit

ImapFolderThread(IListUniqueId, ThreadingAlgorithm, SearchQuery, CancellationToken) Method

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 IList<MessageThread> Thread(
	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

IListMessageThread
An array of message threads.

Implements

IMailFolderThread(IListUniqueId, ThreadingAlgorithm, SearchQuery, CancellationToken)
IMailFolderThread(IListUniqueId, ThreadingAlgorithm, SearchQuery, CancellationToken)
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionalgorithm is not supported.
ArgumentNullException

uids is null.

-or-

query is null.

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.
Remarks
See Also