Click or drag to resize
MimeKit

ImapFolderRenameAsync Method

Asynchronously rename the folder to exist with a new name under a new parent folder.

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

Implements

IMailFolderRenameAsync(IMailFolder, String, CancellationToken)
IMailFolderRenameAsync(IMailFolder, String, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

parent is null.

-or-

name is null.

ArgumentException

parent does not belong to the ImapClient.

-or-

name is not a legal folder name.

ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
FolderNotFoundException The ImapFolder does not exist.
InvalidOperationException The folder cannot be renamed (it is either a namespace or the Inbox).
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
Renames the folder to exist with a new name under a new parent folder.
See Also