Pop 3ClientDelete Messages Async(Int 32, Int 32, Cancellation Token) Method
Asynchronously mark the specified range of messages for deletion.
Definition
Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
An asynchronous task context.
IMailSpoolDeleteMessagesAsync(Int32, Int32, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override 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)IMailSpoolDeleteMessagesAsync(Int32, Int32, CancellationToken)
Remarks
Messages marked for deletion are not actually deleted until the session
is cleanly disconnected
(see Disconnect(Boolean, CancellationToken)).
Example
C#
public static void DownloadMessages ()
{
using (var client = new Pop3Client ()) {
client.Connect ("pop.gmail.com", 995, SecureSocketOptions.SslOnConnect);
client.Authenticate ("username", "password");
int count = client.Count;
var messages = client.GetMessages (0, count);
for (int i = 0; i < messages.Count; i++) {
// write the message to a file
messages[i].WriteTo (string.Format ("{0}.eml", i));
}
client.DeleteMessages (0, count);
client.Disconnect (true);
}
}
Exceptions
| ArgumentOutOfRangeException | startIndex and count do not specify a valid range of messages. |
| ObjectDisposedException | The Pop3Client has been disposed. |
| ServiceNotConnectedException | The Pop3Client is not connected. |
| ServiceNotAuthenticatedException | The Pop3Client is not authenticated. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| IOException | An I/O error occurred. |
| Pop3CommandException | The POP3 command failed. |
| Pop3ProtocolException | A POP3 protocol error occurred. |