Click or drag to resize
MimeKit

MailSpoolDeleteMessage Method

Mark the specified message for deletion.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
Copy
public abstract void DeleteMessage(
	int index,
	CancellationToken cancellationToken = default
)

Parameters

index  Int32
The index of the message.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Implements

IMailSpoolDeleteMessage(Int32, CancellationToken)
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionindex 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.
Remarks
Messages marked for deletion are not actually deleted until the session is cleanly disconnected (see Disconnect(Boolean, CancellationToken)).
Example
C#
Copy
public static void DownloadMessages ()
{
    using (var client = new Pop3Client ()) {
        client.Connect ("pop.gmail.com", 995, SecureSocketOptions.SslOnConnect);

        client.Authenticate ("username", "password");

        for (int i = 0; i < client.Count; i++) {
            var message = client.GetMessage (i);

            // write the message to a file
            message.WriteTo (string.Format ("{0}.msg", i));

            // mark the message for deletion
            client.DeleteMessage (i);
        }

        client.Disconnect (true);
    }
}
See Also