IMailFolderRenameAsync Method

Asynchronously rename the folder.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
Task RenameAsync(
	IMailFolder parent,
	string name,
	CancellationToken cancellationToken = default
)

Parameters

parent  IMailFolder
The new parent folder.
name  String
The new name of the folder.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

Task
An asynchronous task context.

Remarks

Asynchronously renames the folder.

Exceptions

ArgumentNullException

parent is .

-or-

name is .
ArgumentException

parent does not belong to the IMailStore.

-or-

name is not a legal folder name.
ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore is not authenticated.
InvalidOperationException The folder cannot be renamed (it is either a namespace or the Inbox).
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