Pop3BeginDownloadMessage Method

Note: This API is now obsolete.

Begins an asynchronous request for downloading the specified message header or entire message from the server.

Namespace: MailBee.Pop3Mail
Assembly: MailBee.NET (in MailBee.NET.dll) Version: 12.5.0 build 687 for .NET 4.5
Syntax
Copy
[ObsoleteAttribute("This method is obsolete in .NET 4.5+. Use DownloadEntireMessageAsync or DownloadMessageHeaderAsync instead.")]
public IAsyncResult BeginDownloadMessage(
	int index,
	int bodyLineCount,
	AsyncCallback callback,
	Object state
)

Parameters

index
Type: SystemInt32
The ordinal position of the message in the inbox. It must be in the range from 1 to InboxMessageCount. Can be negative in the range from -1 to -InboxMessageCount, i.e. -1 denotes the last e-mail in the inbox.
bodyLineCount
Type: SystemInt32
Number of lines of the message source body to download in addition to the message source header, or -1 to download the entire message.
callback
Type: SystemAsyncCallback
The AsyncCallback delegate. You can leave it a null reference (Nothing in Visual Basic) if you do not use callbacks.
state
Type: SystemObject
An object that contains state information for this request. You can leave it a null reference (Nothing in Visual Basic).

Return Value

Type: IAsyncResult
An IAsyncResult that references the asynchronous downloading the message.
Exceptions
ExceptionCondition
MailBeeInvalidStateExceptionThere is already an operation in progress.
Remarks

This method is an asynchronous version of DownloadMessageHeader(Int32).

If multiple messages or message headers are downloaded, it's recommended to use BeginDownloadMessages(Int32, Int32, Int32, AsyncCallback, Object) method, since it can operate much faster if the server supports pipelining.

Examples
This WinForms sample demonstrates asynchronous downloading of the first message in the inbox. No callback function is used. Once the message is downloaded, all the attachments to the message are saved into C:\Temp folder.
Copy
// To use the code below, import MailBee namespaces at the top of your code.
using MailBee;
using MailBee.Pop3Mail;
using MailBee.Mime;

// Put the code below inside your class.

// The actual code.
private void Form1_Load(object sender, System.EventArgs e)
{
    Pop3 pop = new Pop3();

    // Let MailBee process events.
    pop.RaiseEventsViaMessageLoop = false;

    pop.Connect("pop.somehost.com");
    pop.Login("jdoe", "secret");

    // Initiate an asynchronous download attempt.
    // bodyLineCount = -1 to indicate the entire message must be downloaded.
    pop.BeginDownloadMessage(1, -1, null, null);

    // Simulate some lengthy work here...
    for (int i = 0; i < 100; i++)
    {
        // Make a portion of the work.
        System.Threading.Thread.Sleep(10);

        // Process events which were raised during execution of the work above.
        pop.Wait(0);
    }

    // End the message download operation and return MailMessage object.
    // If the operation is still in progress at the moment when 
    // this method starts, the method will wait until the operation completion.
    MailMessage msg = pop.EndDownloadMessage();

    // Save all attachments into C:\Temp folder.
    msg.Attachments.SaveAll(@"C:\Temp");

    // Disconnect from the server.
    pop.Disconnect();
}
See Also