Mail FolderClose Async Method
Asynchronously close the folder, optionally expunging the messages marked for deletion.
Definition
Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
An asynchronous task context.
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public abstract Task CloseAsync(
bool expunge = false,
CancellationToken cancellationToken = default
)Parameters
- expunge Boolean (Optional)
- If set to , expunge.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskAn asynchronous task context.
Implements
IMailFolderCloseAsync(Boolean, CancellationToken)Remarks
Asynchronously closes the folder, optionally expunging the messages marked for deletion.
Exceptions
| ObjectDisposedException | The IMailStore has been disposed. |
| ServiceNotConnectedException | The IMailStore is not connected. |
| ServiceNotAuthenticatedException | The IMailStore is not authenticated. |
| FolderNotOpenException | The folder is not currently open. |
| 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. |