RenameMailbox Method


Renames existing mailbox on the IMAP4 server.

If mailbox names you're dealing with may contain non-English characters, please read UTF7EncodeMailboxNames topic to make sure everything's done right.


blnResult = ObjectName.RenameMailbox(OldName, NewName)  
Parameters:  
OldName As String Existing mailbox name  
NewName As String New mailbox name  
Return value As Boolean True if successful, False if error has occurred. You can check ErrDesc property or log file to get more detailed error information  

Usage example:

' This sample renames "Archive" mailbox into "Backup".

Dim Mailer
'Using visual basic to create object
Set Mailer = CreateObject("MailBee.IMAP4")
'Using ASP to create object
'Set Mailer = Server.CreateObject("MailBee.IMAP4")
'In ASP use Response.Write instead of MsgBox

Mailer.EnableLogging = True ' Logging helps to discover any problems
Mailer.LogFilePath = "C:\Temp\imap4_log.txt"

Mailer.LicenseKey = "put your license key here"
If Mailer.Connect("mailserver.com", 143, "MyName", "MyPassword") Then
  If Mailer.RenameMailbox("Archive", "Backup") Then
    MsgBox "Mailbox renamed successfully"
  End If
  Mailer.Disconnect
Else
  MsgBox Mailer.ErrDesc
End If

See Also:

RetrieveMailboxes Method
SelectMailbox Method

CreateMailbox Method
DeleteMailbox Method


Copyright © 2002-2024, AfterLogic Corporation. All rights reserved.