Click or drag to resize
MimeKit

ImapFolderCreateAsync(String, IEnumerableSpecialFolder, CancellationToken) Method

Asynchronously create a new subfolder with the given name.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.12.1
Syntax
C#
Copy
public override Task<IMailFolder> CreateAsync(
	string name,
	IEnumerable<SpecialFolder> specialUses,
	CancellationToken cancellationToken = default
)

Parameters

name  String
The name of the folder to create.
specialUses  IEnumerableSpecialFolder
A list of special uses for the folder being created.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskIMailFolder
The created folder.

Implements

IMailFolderCreateAsync(String, IEnumerableSpecialFolder, CancellationToken)
IMailFolderCreateAsync(String, IEnumerableSpecialFolder, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

name is .

-or-

specialUses is .

ArgumentExceptionname 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.
NotSupportedException The IMAP server does not support the CREATE-SPECIAL-USE extension.
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.
Remarks
Creates a new subfolder with the given name.
See Also