IMailFolderCreate(String, IEnumerableSpecialFolder, CancellationToken) Method

Create a new subfolder with the given name.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
IMailFolder? Create(
	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

IMailFolder
The created folder.

Remarks

Creates a new subfolder with the given name.

Exceptions

ArgumentNullException

name is .

-or-

specialUses is .

ArgumentException name is empty.
ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore is not authenticated.
InvalidOperationException The DirectorySeparator is nil, and thus child folders cannot be created.
NotSupportedException The MailService does not support the creation of special folders.
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