ComponentPro UltimateBounceInspector

      RenameFolderAsync(String, String, Object) Method

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      Asynchronously renames a specified folder to a new name.

      Syntax

      public Task RenameFolderAsync(
         string folder, 
         string newFolderName, 
         object userState = null
      )

      Parameters

      folder
      Folder to be renamed.
      newFolderName
      New folder name.
      userState
      A user-provided object that identifies this particular asynchronous operation.

      Return Value

      An object that references the asynchronous operation.

      Examples

      Connect to an IMAP server and asynchronously rename an existing mailbox (Event-based asynchronous approach).

      using System;
      using System.ComponentModel;
      using ComponentPro;
      using ComponentPro.Net.Mail;
      
      ...
      
      // Create a new instance of the Imap class.
      Imap client = new Imap();
      
      // Connect to the server. 
      await client.ConnectAsync("myserver");
      
      // Or you can specify the IMAP port with 
      // client.Connect("myserver", 143); 
       
      // Login to the server. 
      await client.AuthenticateAsync("user", "password");
      
      // ... 
       
      // Select the 'INBOX' folder. 
      await client.SelectAsync("INBOX");
      
      // Delete a mailbox in the current working mailbox. 
      await client.RenameFolderAsync("my folder", "new folder name");
      
      // ...
      
      Console.WriteLine("Folder renamed.");
      
      // Disconnect.
      client.Disconnect();

      Connect to an IMAP server and asynchronously rename an existing mailbox (Event-based asynchronous approach).

      using System;
      using System.ComponentModel;
      using ComponentPro;
      using ComponentPro.Net.Mail;
      
      ...
      
      public void DoRenameFolderAsync()
      {
          // 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.RenameFolderCompleted += client_RenameFolderCompleted;
      
          // Select the 'INBOX' folder. 
          client.Select("INBOX");
      
          // Delete a mailbox in the current working mailbox. 
          client.RenameFolderAsync("my folder", "new folder name");
      
          // ... 
       
          // Disconnect. 
          client.Disconnect();
      }
      
      void client_RenameFolderCompleted(object sender, AsyncCompletedEventArgs e)
      {
          // Imap client = (Imap)sender; 
          if (e.Error != null)
          {
              Console.WriteLine("Error: " + e.Error.ToString());
          }
          else 
              Console.WriteLine("Folder renamed.");
      }

      Framework

      .NET Compact Framework.NET Compact Framework

      Supported version: 2.0, 3.5, and 3.9
      Assembly: ComponentPro.Mail.CF (in ComponentPro.Mail.CF.dll)

      .NET Framework.NET Framework

      Supported version: 2.0, 3.0, 3.5, 4.0, 4.5.x, 4.6.x and later
      Assembly: ComponentPro.Mail (in ComponentPro.Mail.dll)

      Xamarin AndroidXamarin Android

      Supported version: 2.3 and later
      Assembly: ComponentPro.Mail.Android (in ComponentPro.Mail.Android.dll)

      Xamarin MacXamarin Mac

      Supported version: 2.0.x and later
      Assembly: ComponentPro.Mail.Mac (in ComponentPro.Mail.Mac.dll)

      Xamarin iOSXamarin iOS

      Supported version: 5.1.x and later
      Assembly: ComponentPro.Mail.iOS (in ComponentPro.Mail.iOS.dll)

      See Also