Namespace: "urn:zimbraAdmin"
GetShareInfo SOAP Command

Iterate through all folders of the owner's mailbox and return shares that match grantees specified by the <grantee> specifier.
e.g.

      <GetShareInfoRequest>
          <grantee name="dl@test.com"/>]
          <owner by="name">user1@test.com</owner>
      </GetShareInfoRequest>
 
returns all shares owned by user1@test.com that are shared with dl@test.com.

Authorization token required true
Admin Authorization token required true

GetShareInfoRequest

    <GetShareInfoRequest> ## GetShareInfoRequest
        <grantee [type="{grantee-type}"] [id="{grantee-id}"] [name="{grantee-name}"] /> ## GranteeChooser
        <owner by="{acct-selector-by} (adminName|appAdminName|id|foreignPrincipal|name|krb5Principal)">{key}</owner> ## AccountSelector
    </GetShareInfoRequest>

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

XPath Required / Optional Description
/grantee Optional (0 or 1) Grantee
/grantee@type Optional (0 or 1) Type:String
If specified, filters the result by the specified grantee type.
/grantee@id Optional (0 or 1) Type:String
If specified, filters the result by the specified grantee ID.
/grantee@name Optional (0 or 1) Type:String
If specified, filters the result by the specified grantee name.
/owner Required (only 1) Type:{key}
Owner
Description for element text content:The key used to identify the account. Meaning determined by {acct-selector-by}
/owner@by Required (only 1) Type:adminName|appAdminName|id|foreignPrincipal|name|krb5Principal
Select the meaning of {acct-selector-key}

GetShareInfoResponse

    <GetShareInfoResponse> ## GetShareInfoResponse
        (<share ownerId="{share-owner-id}" ownerEmail="{share-owner-email}" ownerName="{share-owner-display-name}"
                    folderId="{share-folder-id} (int)" folderUuid="{share-folder-uuid}"
                    folderPath="{share-fully-qualified-path}" view="{share-default-view}" rights="{share-rights}"
                    granteeType="{grantee-type}" granteeId="{grantee-id}" granteeName="{grantee-name}"
                    granteeDisplayName="{grantee-display-name}" [mid="{mountpoint-id}"] /> ## ShareInfo)*
    </GetShareInfoResponse>

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

XPath Required / Optional Description
/share Optional (0 or more) Share information
/share@ownerId Required (only 1) Type:String
Owner ID
/share@ownerEmail Required (only 1) Type:String
Owner email
/share@ownerName Required (only 1) Type:String
Owner display name
/share@folderId Required (only 1) Type:int
Folder ID
/share@folderUuid Required (only 1) Type:String
Folder UUID
/share@folderPath Required (only 1) Type:String
Fully qualified path
/share@view Required (only 1) Type:String
Default type
/share@rights Required (only 1) Type:String
Rights
/share@granteeType Required (only 1) Type:String
Grantee type
/share@granteeId Required (only 1) Type:String
Grantee ID
/share@granteeName Required (only 1) Type:String
Grantee name
/share@granteeDisplayName Required (only 1) Type:String
Grantee display name
/share@mid Optional (0 or 1) Type:String
Returned if the share is already mounted. Contains the folder id of the mountpoint in the local mailbox.