Click or drag to resize
MimeKit

IMailFolderGetMessageAsync(Int32, CancellationToken, ITransferProgress) Method

Asynchronously get the specified message.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Task<MimeMessage> GetMessageAsync(
	int index,
	CancellationToken cancellationToken = default,
	ITransferProgress progress = null
)

Parameters

index  Int32
The index of the message.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

TaskMimeMessage
The message.
Remarks
Asynchronously gets the specified message.
Example
C#
public static void DownloadMessages ()
{
    using (var client = new ImapClient ()) {
        client.Connect ("imap.gmail.com", 993, SecureSocketOptions.SslOnConnect);

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

        client.Inbox.Open (FolderAccess.ReadOnly);

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

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

        client.Disconnect (true);
    }
}
See Also