MailKit Documentation
API Reference
MailKit.Net.Imap
ImapFolder Class
ImapFolder Methods
AddAccessRights Method
AddAccessRightsAsync Method
Append Method
AppendAsync Method
Check Method
CheckAsync Method
Close Method
CloseAsync Method
CommitStream Method
CopyTo Method
CopyToAsync Method
Create Method
CreateAsync Method
CreateStream Method
Delete Method
DeleteAsync Method
Expunge Method
ExpungeAsync Method
Fetch Method
FetchAsync Method
GetAccessControlList Method
GetAccessControlListAsync Method
GetAccessRights Method
GetAccessRightsAsync Method
GetBodyPart Method
GetBodyPartAsync Method
GetEnumerator Method
GetHeaders Method
GetHeadersAsync Method
GetMessage Method
GetMessageAsync Method
GetMetadata Method
GetMetadataAsync Method
GetMyAccessRights Method
GetMyAccessRightsAsync Method
GetQuota Method
GetQuotaAsync Method
GetStream Method
GetStreamAsync Method
GetStreams Method
GetStreamsAsync Method
GetSubfolder Method
GetSubfolderAsync Method
GetSubfolders Method
GetSubfoldersAsync Method
MoveTo Method
MoveToAsync Method
OnParentFolderRenamed Method
Open Method
OpenAsync Method
RemoveAccess Method
RemoveAccessAsync Method
RemoveAccessRights Method
RemoveAccessRightsAsync Method
Rename Method
RenameAsync Method
Replace Method
ReplaceAsync Method
Search Method
SearchAsync Method
SetAccessRights Method
SetAccessRightsAsync Method
SetMetadata Method
SetMetadataAsync Method
SetQuota Method
SetQuotaAsync Method
Sort Method
SortAsync Method
Status Method
StatusAsync Method
Store Method
StoreAsync Method
Subscribe Method
SubscribeAsync Method
Supports Method
Thread Method
ThreadAsync Method
Unsubscribe Method
UnsubscribeAsync Method
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.7.1
Syntax
C#
Copy
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