MailFolderExpungeAsync(IListUniqueId, CancellationToken) Method

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

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

Syntax

public abstract Task ExpungeAsync(
	IList<UniqueId> uids,
	CancellationToken cancellationToken = default
)

Task
An asynchronous task context.

Exceptions

Exception	Condition
ArgumentNullException	uids is null.
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.

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 EnableQuickResync(CancellationToken) method, then the MessagesVanished event will be emitted rather than the MessageExpunged event.