IMailFolderOpenAsync(FolderAccess, CancellationToken) Method

Asynchronously open the folder using the requested folder access.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
Task<FolderAccess> OpenAsync(
	FolderAccess access,
	CancellationToken cancellationToken = default
)

Parameters

access  FolderAccess
The requested folder access.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskFolderAccess
The FolderAccess state of the folder.

Remarks

Asynchronously opens the folder using the requested folder access.

Exceptions

ArgumentOutOfRangeException access is not a valid value.
ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore is not authenticated.
FolderNotFoundException The MailFolder does not exist.
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.

See Also