Rename Method

Rename mailbox.

long Rename([in] BSTR NewName)

Parameters

NewName

New name of mailbox.

Return Value

Return value is zero if this method succeeds; otherwise return value is non-zero.

Remarks

Mailbox with MBX_SYSTEM(1) flags can't be renamed or deleted.

Usage Example

Dim server, user, password, requestAddr
server = "localhost"
user = "hunter@emailarchitect.net"
password = "mypassword"
requestAddr = "192.168.0.1"

Dim oSvr
Set oSvr = CreateObject("EmailArchitectObjects.ServerRoot")
r = oSvr.Connect( server, user, password, 0, requestAddr )
If r <> 0 Then
  WScript.Echo( "connect server failed!" )
  WScript.Quit
End If

Dim oDomains, oDomain
Set oDomains = oSvr.DomainCollection
Set oDomain = oDomains.Items(CStr(oSvr.Domain)) 

Dim oUsers, oUser
Set oUsers = oDomain.UserCollection
Set oUser = oUsers.Items(CStr(oSvr.User))

Dim oMBXs, oMBX, oTools
Set oTools = CreateObject("EmailArchitectObjects.Tools")
Set oMBXs = oUser.MBXCollection

Set oMBX = oMBXs.Items(CStr(oTools.EncodeHex("my folder")))
If oMBX Is Nothing Then
  WScript.Echo( "this mailbox doesn't exist" )
  WScript.Quit
End If

If oMBX.Rename(oTools.EncodeHex("my new folder")) <> 0 Then
  WScript.Echo( "rename failed" )
End If