Click or drag to resize
MimeKit

MailFolderGetSubfoldersAsync(StatusItems, Boolean, CancellationToken) Method

Asynchronously get the subfolders.

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

See Also