Imap.QuickDownloadMessages Method (String, String, String, String, Int32)

Downloads all the messages (entire messages or message headers only) in the specified folder on the server, in a single line of code.

public static MailMessageCollection QuickDownloadMessages(
   string serverName,
   string accountName,
   string password,
   string folderName,
   int bodyPreviewSize
);

Parameters

serverName: The name or IP address of the IMAP4 server.
accountName: The user account name on the server.
password: The password of the user account on the server.
folderName: The full name of the folder to download the messages from.
bodyPreviewSize: Number of bytes of a message source body to download in addition to a message source header, or -1 to download entire messages, or 0 to download message headers only.

Return Value

A MailMessageCollection object containing the downloaded messages.

Remarks

This method does not delete any messages in the folder.

An account on the mail server is guaranteed to contain at least "Inbox" folder. The "Inbox" name is case-sensitive ("Inbox", "inbox", and "INBOX" are equivalent). Other folder names, however, may be case-senstive depending on the server implementation.

Since MailBee is capable of downloading multiple messages in a batch, using this method is much more efficient than calling QuickDownloadMessage method multiple times.

Note Static methods still require the valid license key be assigned to LicenseKey property (by either setting in in the code or in the config file such as app.config). All samples in MailBee documentation assume the license key is already set in the config file.

Exceptions

Exception Type	Condition
MailBeeException	An error occurred.

Example

This sample downloads headers of all the messages in the inbox, and displays indices (ordinal positions in the inbox) of all messages which likely have any attachments.

[C#]
// To use the code below, import MailBee namespaces at the top of your code.
using MailBee;
using MailBee.ImapMail;
using MailBee.Mime;

// The actual code (put it into a method of your class).
MailMessageCollection msgs = Imap.QuickDownloadMessages("mail.company.com", "login", "password", "Inbox", 0);
foreach (MailMessage msg in msgs)
{
    if (msg.HasAttachments)
    {
        Console.WriteLine("Message #" + msg.IndexOnServer +
            " seems to have any attachments");
    }
}