Mail SpoolDelete Messages Async(Int 32, Int 32, Cancellation Token) Method
Asynchronously mark the specified range of messages 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 DeleteMessagesAsync(
int startIndex,
int count,
CancellationToken cancellationToken = default
)Parameters
- startIndex Int32
- The index of the first message to mark for deletion.
- count Int32
- The number of messages to mark for deletion.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskAn asynchronous task context.
Implements
IMailSpoolDeleteMessagesAsync(Int32, Int32, CancellationToken)Remarks
Messages marked for deletion are not actually deleted until the session
is cleanly disconnected
(see Disconnect(Boolean, CancellationToken)).
Exceptions
| ArgumentOutOfRangeException | startIndex and count do not specify a valid range of messages. |
| 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. |