Mail SpoolDelete Message Async Method
Asynchronously mark the specified message for deletion.
Definition
Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
An asynchronous task context.
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public abstract Task DeleteMessageAsync(
int index,
CancellationToken cancellationToken = default
)Parameters
- index Int32
- The index of the message.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskAn asynchronous task context.
Implements
IMailSpoolDeleteMessageAsync(Int32, CancellationToken)Remarks
Messages marked for deletion are not actually deleted until the session
is cleanly disconnected
(see Disconnect(Boolean, CancellationToken)).
Exceptions
| ArgumentOutOfRangeException | index is not a valid message index. |
| ObjectDisposedException | The MailSpool has been disposed. |
| ServiceNotConnectedException | The MailSpool is not connected. |
| ServiceNotAuthenticatedException | The MailSpool is not authenticated. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| IOException | An I/O error occurred. |
| CommandException | The command failed. |
| ProtocolException | A protocol error occurred. |