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

Show mailbox moves in progress on this server. Both move-ins and move-outs are shown.
If accounts are given only data for those accounts are returned. Data for all moves are returned if no accounts are given.
If checkPeer=1 (true), peer servers are queried to check if the move is active on the peer. [default 0 (false)]

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

QueryMailboxMoveRequest

    <QueryMailboxMoveRequest [checkPeer="(0|1)"]> ## QueryMailboxMoveRequest
        (<account name="{name}" /> ## Name)*
    </QueryMailboxMoveRequest>

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

XPath Required / Optional Description
@checkPeer Optional (0 or 1) Type:0|1
Flag whether to query peer servers to see if the move is active on them. [default 0 (false)]
/account Optional (0 or more) Accounts - If empty report on all outstanding moves
/account@name Required (only 1) Type:String
Name

QueryMailboxMoveResponse

    <QueryMailboxMoveResponse> ## QueryMailboxMoveResponse
        (<account name="{account-email-address}" start="{move-start-millis} (long)" type="(out|in)" src="{src-hostname}"
                      dest="{dest-hostname}" [noPeer="{no-peer} (0|1)"] /> ## MailboxMoveInfo)*
    </QueryMailboxMoveResponse>

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

XPath Required / Optional Description
/account Optional (0 or more) Information about mailbox moves that are in progress
/account@name Required (only 1) Type:String
Account email address
/account@start Required (only 1) Type:long
Move start time in milliseconds
/account@type Required (only 1) Type:out|in
Mailbox move type. Whether this is a move-out to destination server or move-in from source server
/account@src Required (only 1) Type:String
Hostname of source server (this server's howtname if type="out")
/account@dest Required (only 1) Type:String
Hostname of destination server (this server's howtname if type="in")
/account@noPeer Optional (0 or 1) Type:0|1
Set if move is NOT in progress on destination server; only used when checkPeer was set in the request.
If noPeer is set, it can mean one of:
  1. The peer server is not reachable
  2. The peer server doesn't think account is being moved (possible if peer was restarted during a move)
  3. Race condition (because move status on multiple servers are not updated/queried transactionally)