Service: zimbraMail
Namespace: "urn:zimbraMail"
GetShareDetails SOAP Command

Get item acl details

Authorization token required true
Admin Authorization token required false

GetShareDetailsRequest

    <GetShareDetailsRequest> ## GetShareDetailsRequest
        <item [id="..."] /> ## Id
    </GetShareDetailsRequest>

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

XPath Required / Optional Description
/item Required (only 1) Item ID
/item@id Optional (0 or 1) Type:String
ID

GetShareDetailsResponse

    <GetShareDetailsResponse> ## GetShareDetailsResponse
        <item id="{item-id}"> ## ShareDetails
            (<grantee perm="{rights}" gt="{grantee-type} (usr|grp|cos|pub|all|dom|guest|key)"
                          [name="{grantee-display-name}"] [email="{grantee-email}"] /> ## ShareGrantee)*
        </item>
    </GetShareDetailsResponse>

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

XPath Required / Optional Description
/item Required (only 1) Details on the item being shared
/item@id Required (only 1) Type:String
Shared item ID
/item/grantee Optional (0 or more) Grantees
/item/grantee@perm Required (only 1) Type:String
Rights - Some combination of (r)ead, (w)rite, (i)nsert, (d)elete, (a)dminister, workflow action (x), view (p)rivate, view (f)reebusy, (c)reate subfolder
/item/grantee@gt Required (only 1) Type:usr|grp|cos|pub|all|dom|guest|key
The type of Grantee:
     "usr",
     "grp",
     "dom" (domain),
     "cos",
     "all" (all authenticated users), "pub" (public authenticated and unauthenticated access),
     "guest" (non-Zimbra email address and password),
     "key" (non-Zimbra email address and access key)
 
/item/grantee@name Optional (0 or 1) Type:String
Name of the principal that has been granted rights. Optional if {grantee-type} is "all"/"guest"/"pub".
/item/grantee@email Optional (0 or 1) Type:String
Email address of the principal that has been granted rights. Optional if {grantee-type} is not "usr"/"grp".