MailStoreGetFolders(FolderNamespace, Boolean, CancellationToken) Method

Get all of the folders within the specified namespace.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public virtual IList<IMailFolder> GetFolders(
	FolderNamespace namespace,
	bool subscribedOnly,
	CancellationToken cancellationToken = default
)

Parameters

namespace  FolderNamespace
The namespace.
subscribedOnly  Boolean
If set to , only subscribed folders will be listed.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

IListIMailFolder
The folders.

Implements

IMailStoreGetFolders(FolderNamespace, Boolean, CancellationToken)

Remarks

Gets all of the folders within the specified namespace.

Exceptions

ArgumentNullException namespace is .
ObjectDisposedException The MailStore has been disposed.
ServiceNotConnectedException The MailStore is not connected.
ServiceNotAuthenticatedException The MailStore is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
ProtocolException A protocol error occurred.
CommandException The command failed.

See Also