ComponentPro UltimateMail

      Deleting messages Asynchronously

      Language Filter: AllSend comments on this topic to ComponentPro

      Use DeleteMessageAsync methods to asynchronously delete multiple messages at once. These methods asynchronously delete multiple messages at once with execution occurring on a new thread, therefore they allow your next line of code to execute immediately.

      In Task-based Asynchronous programs, the single asynchronous method represents the initiation and completion of an asynchronous operation. You may create the continuation code either explicitly, through methods on the Task class (for example, ContinueWith) or implicitly, by using language support built on top of continuations (for example, await in C#, Await in Visual Basic).

      In .NET 4.5 it is recommended to implement the Task-based Asynchronous Pattern.

      In Event-based Asynchronous programs, the event DeleteMessageCompleted is raised when the DeleteMessageAsync completes. In the event handler method of the DeleteMessageCompleted, you can check if there were any errors by using the Error property of the event data object.

      The following example demonstrates how to asynchronously determine whether a mailbox exists:

      Task-based approach

      using ComponentPro.Net.Mail;
      
      ...
      
      // Create a new instance of the Imap class.
      Imap client = new Imap();
      
      // Connect to the server.
      client.Connect("myserver");
      
      // Or you can specify the IMAP port with 
      // client.Connect("myserver", 143); 
       
      // Login to the server.
      client.Authenticate("user", "password");
      
      // ... 
       
      // Select 'INBOX' mailbox.
      client.Select("INBOX");
      
      ImapMessageIdCollection set = new ImapMessageIdCollection(1, 2, 3);
      
      // Delete mail messages with sequence numbers 1, 2, and 3. 
      await client.DeleteMessageAsync(set);
      
      // ... 
       
      // Disconnect.
      client.Disconnect();
      

      Event-based approach

      using System;
      using System.ComponentModel;
      using ComponentPro;
      using ComponentPro.Net.Mail;
      
      ...
      
      public void DoDeleteMessagesAsync()
      {
          // Create a new instance of the Imap class. 
          Imap client = new Imap();
      
          // Connect to the server. 
          client.Connect("myserver");
      
          // Or you can specify the IMAP port with 
          // client.Connect("myserver", 143); 
       
          // Login to the server. 
          client.Authenticate("user", "password");
      
          // ... 
       
          // Register an event handler. 
          client.DeleteMessageCompleted += client_DeleteMessageCompleted;
      
          // Select 'INBOX' mailbox. 
          client.Select("INBOX");
      
          ImapMessageIdCollection set = new ImapMessageIdCollection(1, 2, 3);
      
          // Delete mail messages with sequence numbers 1, 2, and 3. 
          client.DeleteMessageAsync(set);
      
          // ... 
       
          // Disconnect. 
          client.Disconnect();
      }
      
      void client_DeleteMessageCompleted(object sender, AsyncCompletedEventArgs e)
      {
          if (e.Error != null)
          {
              Console.WriteLine("Error: " + e.Error.ToString());
          }
          else 
          {
              Console.WriteLine("Messages deleted successfully.");
          }
      }