Imap FolderClose Async Method
Asynchronously close the folder, optionally expunging the messages marked for deletion.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
An asynchronous task context.
IMailFolderCloseAsync(Boolean, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override 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)IMailFolderCloseAsync(Boolean, CancellationToken)
Remarks
Closes the folder, optionally expunging the messages marked for deletion.
Exceptions
| ObjectDisposedException | The ImapClient has been disposed. |
| ServiceNotConnectedException | The ImapClient is not connected. |
| ServiceNotAuthenticatedException | The ImapClient is not authenticated. |
| FolderNotOpenException | The ImapFolder is not currently open. |
| 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. |