Pop3BeginDeleteMessages Method

Note: This API is now obsolete.

Begins an asynchronous request for flagging the specified range of messages for deletion from the server.

Namespace: MailBee.Pop3Mail
Assembly: MailBee.NET (in MailBee.NET.dll) Version: 12.4 build 677 for .NET 4.5
Syntax
Copy
[ObsoleteAttribute("This method is obsolete in .NET 4.5+. Use DeleteMessagesAsync instead.")]
public IAsyncResult BeginDeleteMessages(
	int startIndex,
	int count,
	AsyncCallback callback,
	Object state
)

Parameters

startIndex
Type: SystemInt32
The ordinal position (in the inbox) of the first message in the range being deleted.
count
Type: SystemInt32
Number of messages to be flagged for deletion, or -1 to indicate that all messages in the range startIndex to InboxMessageCount must be flagged for deletion.
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 flagging the messages for deletion.
Exceptions
ExceptionCondition
MailBeeInvalidStateExceptionThere is already an operation in progress.
Remarks
This method is an asynchronous version of DeleteMessages(Int32, Int32).
Examples
This WinForms sample demonstrates asynchronous flagging 5 last messages in the inbox for deletion. No callback function is used.
Copy
// To use the code below, import MailBee namespaces at the top of your code.
using MailBee;
using MailBee.Pop3Mail;

// 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 deletion attempt.
    pop.BeginDeleteMessages(pop.InboxMessageCount - 4, 5, 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 flagging operation. If it's in progress at the moment 
    // this method starts, it will wait until it's done first.
    pop.EndDeleteMessages();

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