 | Mail |
Asynchronously rename the folder.
Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
SyntaxC#
public abstract 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
TaskAn asynchronous task context.
Implements
IMailFolderRenameAsync(IMailFolder, String, CancellationToken)Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | parent is null. -or- name is null. |
| 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. |
Remarks
Asynchronously renames the folder.
See Also