ImapFolderCreateAsync(String, Boolean, CancellationToken) Method

Asynchronously create a new subfolder with the given name.

Definition

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task<IMailFolder?> CreateAsync(
	string name,
	bool isMessageFolder,
	CancellationToken cancellationToken = default
)

Parameters

name  String
The name of the folder to create.
isMessageFolder  Boolean
if the folder will be used to contain messages; otherwise, .
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskIMailFolder
The created folder.

Implements

IMailFolderCreateAsync(String, Boolean, CancellationToken)
IMailFolderCreateAsync(String, Boolean, CancellationToken)

Remarks

Creates a new subfolder with the given name.

Exceptions

ArgumentNullException name is .
ArgumentException name is empty or invalid.
ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
InvalidOperationException The DirectorySeparator is nil, and thus child folders cannot be created.
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