Show/Hide TOC

IMailFolderExtensionsExpungeAsync Method

Asynchronously expunge the specified uids, permanently removing them from the folder.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0

C#

public static Task ExpungeAsync(
	this IMailFolder folder,
	IList<UniqueId> uids,
	CancellationToken cancellationToken = default
)

Parameters

folder IMailFolder: The folder.
uids IListUniqueId: The message uids.
cancellationToken CancellationToken (Optional): The cancellation token.

Return Value

Task
An asynchronous task context.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMailFolder. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Asynchronously expunges the specified uids, permanently removing them from the folder.

Note

Normally, an MessageExpunged event will be emitted for each message that is expunged. However, if the mail store supports the quick resynchronization feature and it has been enabled via the Enable(ImapFeatures, CancellationToken) method, then the MessagesVanished event will be emitted rather than the MessageExpunged event.

Exceptions

ArgumentNullException	uids is .
ArgumentException	One or more of the uids is invalid.
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 in read-write mode.
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.