Imap FolderCreate Async(String, IEnumerableSpecial Folder, Cancellation Token) Method
Asynchronously create a new subfolder with the given name.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The created folder.
IMailFolderCreateAsync(String, IEnumerableSpecialFolder, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
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
TaskIMailFolderThe created folder.
Implements
IMailFolderCreateAsync(String, IEnumerableSpecialFolder, CancellationToken)IMailFolderCreateAsync(String, IEnumerableSpecialFolder, CancellationToken)
Remarks
Creates a new subfolder with the given name.
Exceptions
| ArgumentNullException |
name is . -or- specialUses is . |
| ArgumentException | name 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. |