Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
MoveMailbox SOAP Command

Move a mailbox
Note: This request should be sent to the move destination server, rather than the source server.

Moves the mailbox of the specified account to this host. The src and dest attributes are required as safety checks. src must be set to the current home server of the account, and dest must be set to the server receiving the request.

syncFinishThreshold and maxSyncs determine the blob/index sync behavior while account remains unlocked. Unlocked sync phase is done if sync has been repeated maxSyncs times, or if the last sync time was less than or equal to syncFinishThreshold milliseconds. After the unlocked phase the account is locked to quiesce it, then one final sync is done followed by database export/import.

Network edition only API TRUE
Authorization token required true
Admin Authorization token required true

MoveMailboxRequest

    <MoveMailboxRequest> ## MoveMailboxRequest
        <account name="{account-email-address}" dest="{target-svr-hostname}" src="{source-svr-hostname}"
                    [blobs="{include|exclude|config}"] [secondaryBlobs="{include|exclude|config}"]
                    [searchIndex="{include|exclude|config}"] [maxSyncs="{max-syncs} (Integer)"]
                    [syncFinishThreshold="{sync-finish-threshold-millisecs} (Long)"] [sync="{sync} (0|1)"]
                    [skipRemoteLockout="{skipRemoteLockout} (0|1)"] [skipMemcachePurge="{skipMemcachePurge} (0|1)"] /> ## MoveMailboxInfo
    </MoveMailboxRequest>

The following table describes elements and attributes you can define within a <MoveMailboxRequest> element:

XPath Required / Optional Description
/account Required (only 1) Specification for the account move
/account@name Required (only 1) Type:String
Account email address
/account@dest Required (only 1) Type:String
Hostname of target server
/account@src Required (only 1) Type:String
Hostname of source server
/account@blobs Optional (0 or 1) Type:String
Option to include/exclude blobs in a move - include|exclude|config
Default value is "config", to use the configured value. "include" or "exclude" overrides the configuration
/account@secondaryBlobs Optional (0 or 1) Type:String
Option to include/exclude secondary blobs in a move - include|exclude|config
Default value is "config", to use the configured value. "include" or "exclude" overrides the configuration
Meaningful only when blobs isn't excluded.
/account@searchIndex Optional (0 or 1) Type:String
Option to include/exclude searchIndex in a move - include|exclude|config
Default value is "config", to use the configured value. "include" or "exclude" overrides the configuration
/account@maxSyncs Optional (0 or 1) Type:Integer
Maximum number of syncs. Default is 10
/account@syncFinishThreshold Optional (0 or 1) Type:Long
Sync finish threshold. Default is 30000 (30 seconds)
/account@sync Optional (0 or 1) Type:0|1
If set, run synchronously; command doesn't return until move is finished
/account@skipRemoteLockout Optional (0 or 1) Type:0|1
If set, do not lockout the remote mailbox. Used for backward compatibility when moving from legacy server versions
/account@skipMemcachePurge Optional (0 or 1) Type:0|1
If set, do not automatically purge route info from memcache. Provided for special cases where memcache/proxy is handled outside the move process

MoveMailboxResponse

    <MoveMailboxResponse /> ## MoveMailboxResponse