IMailFolderGetSubfoldersAsync(StatusItems, Boolean, CancellationToken) Method

Asynchronously get the subfolders.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.12.1

Syntax

Task<IList<IMailFolder>> GetSubfoldersAsync(
	StatusItems items,
	bool subscribedOnly = false,
	CancellationToken cancellationToken = default
)

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

Exceptions

Exception	Condition
ObjectDisposedException	The IMailStore has been disposed.
ServiceNotConnectedException	The IMailStore is not connected.
ServiceNotAuthenticatedException	The IMailStore is not authenticated.
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

Asynchronously gets the subfolders as well as queries the server for the status of the requested items.

When the items argument is non-empty, this has the equivalent functionality of calling GetSubfoldersAsync(Boolean, CancellationToken) and then calling StatusAsync(StatusItems, CancellationToken) on each of the returned folders.