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

Returns the info on blob and index volumes of a mailbox. Only the volumes that have data for the mailbox are returned. The rootpath attribute is the root of the mailbox data, rather than the root of the volume. Also returns the current sync token of the mailbox.

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

GetMailboxVolumesRequest

    <GetMailboxVolumesRequest> ## GetMailboxVolumesRequest
        <account name="{name}" /> ## Name
    </GetMailboxVolumesRequest>

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

XPath Required / Optional Description
/account Required (only 1) Account email address
/account@name Required (only 1) Type:String
Name

GetMailboxVolumesResponse

    <GetMailboxVolumesResponse> ## GetMailboxVolumesResponse
        <account mbxid="{mailbox-id} (int)" token="{sync-token} (int)"> ## MailboxVolumesInfo
            (<volume id="{volume-id} (short)" type="{volume-type} (short)" rootpath="{volume-rootpath}" /> ## MailboxVolumeInfo)*
        </account>
    </GetMailboxVolumesResponse>

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

XPath Required / Optional Description
/account Required (only 1) Mailbox Volume Information
/account@mbxid Required (only 1) Type:int
Mailbox ID
/account@token Required (only 1) Type:int
Current sync token of the mailbox
/account/volume Optional (0 or more) Volumes
/account/volume@id Required (only 1) Type:short
Volume ID
/account/volume@type Required (only 1) Type:short
Volume type
/account/volume@rootpath Required (only 1) Type:String
Root of the mailbox data