Click or drag to resize
MimeKit

ImapFolderGetSubfoldersAsync(StatusItems, Boolean, CancellationToken) Method

Asynchronously get the subfolders.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public override Task<IList<IMailFolder>> GetSubfoldersAsync(
	StatusItems items,
	bool subscribedOnly = false,
	CancellationToken cancellationToken = default
)

Parameters

items  StatusItems
The status items to pre-populate.
subscribedOnly  Boolean  (Optional)
If set to true, only subscribed folders will be listed.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskIListIMailFolder
The subfolders.

Implements

IMailFolderGetSubfoldersAsync(StatusItems, Boolean, CancellationToken)
IMailFolderGetSubfoldersAsync(StatusItems, Boolean, CancellationToken)
Exceptions
ExceptionCondition
ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
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
Gets the subfolders.
See Also