ImapFolderOpenAsync(FolderAccess, CancellationToken) Method

Asynchronously open the folder using the requested folder access.

Definition

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override 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.

Implements

IMailFolderOpenAsync(FolderAccess, CancellationToken)
IMailFolderOpenAsync(FolderAccess, CancellationToken)

Remarks

Opens the folder using the requested folder access.

Exceptions

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

See Also