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

Get Share notifications

Authorization token required true
Admin Authorization token required false

GetShareNotificationsRequest

    <GetShareNotificationsRequest /> ## GetShareNotificationsRequest

GetShareNotificationsResponse

    <GetShareNotificationsResponse> ## GetShareNotificationsResponse
        (<share status="{status-new|seen}" id="{notification-item-id}" d="{date} (long)"> ## ShareNotificationInfo
            <grantor id="{grantor-zimbra-id}" email="{grantor-email-address}" name="{grantor-display-name}" /> ## Grantor
            <link id="{shared-item-id}" uuid="{uuid}" name="{item-name}" view="{item-type}" [perm="{permissions-granted}"] /> ## LinkInfo
          </share>)*
    </GetShareNotificationsResponse>

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

XPath Required / Optional Description
/share Optional (0 or more) Share notification information
/share@status Required (only 1) Type:String
Status - "new" if the message is unread or "seen" if the message is read.
/share@id Required (only 1) Type:String
The item ID of the share notification message. The message must be in the Inbox folder.
/share@d Required (only 1) Type:long
Date
/share/grantor Required (only 1) Grantor information
/share/grantor@id Required (only 1) Type:String
Zimbra ID
/share/grantor@email Required (only 1) Type:String
Email address
/share/grantor@name Required (only 1) Type:String
Grantor display name
/share/link Required (only 1) Link information
/share/link@id Required (only 1) Type:String
Shared item ID
/share/link@uuid Required (only 1) Type:String
Item's UUID - a globally unique identifier
/share/link@name Required (only 1) Type:String
Item name
/share/link@view Required (only 1) Type:String
Item type
/share/link@perm Optional (0 or 1) Type:String
Permissions granted