MailSpoolGetMessages(Int32, Int32, CancellationToken, ITransferProgress) Method

Get the messages within the specified range.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public abstract IList<MimeMessage> GetMessages(
	int startIndex,
	int count,
	CancellationToken cancellationToken = default,
	ITransferProgress? progress = null
)

Parameters

startIndex  Int32
The index of the first message to get.
count  Int32
The number of messages to get.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

IListMimeMessage
The messages.

Implements

IMailSpoolGetMessages(Int32, Int32, CancellationToken, ITransferProgress)

Remarks

Gets the messages within the specified range.

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 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.

See Also