Click or drag to resize
MimeKit

ImapFolderCloseAsync Method

Asynchronously close the folder, optionally expunging the messages marked for deletion.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
public override Task CloseAsync(
	bool expunge = false,
	CancellationToken cancellationToken = default
)

Parameters

expunge  Boolean  (Optional)
If set to true, expunge.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

Task
An asynchronous task context.

Implements

IMailFolderCloseAsync(Boolean, CancellationToken)
IMailFolderCloseAsync(Boolean, CancellationToken)
Exceptions
ExceptionCondition
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.
Remarks
Closes the folder, optionally expunging the messages marked for deletion.
See Also