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

Get notifications

Authorization token required true
Admin Authorization token required false

GetNotificationsRequest

    <GetNotificationsRequest [markSeen="{mark-seen} (0|1)"] /> ## GetNotificationsRequest

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

XPath Required / Optional Description
@markSeen Optional (0 or 1) Type:0|1
If set then all the notifications will be marked as seen. Default: unset

GetNotificationsResponse

the response contains activities as described in GetActivityStreamResponse

    <GetNotificationsResponse lastSeen="{last-seen} (long)"> ## GetNotificationsResponse
        (<op [name="..."] /> ## NamedElement)*
        (<user [id="{id}"] [email="{email}"] [name="{name}"] /> ## IdEmailName)*
        (<a op="{operation}" ts="{timestamp} (long)" itemId="{item-id}" [ver="{version} (Integer)"] [ua="{user-agent}"]
                [email="{email-address-of-user-performing-action}"]> ## ActivityInfo
            (<arg name="{name}">{value}</arg> ## NamedValue)*
          </a>)*
    </GetNotificationsResponse>

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

XPath Required / Optional Description
@lastSeen Required (only 1) Type:long
Timestamp of when the notifications were last seen
/op Optional (0 or more) Operations
/op@name Optional (0 or 1) Type:String
Name
/user Optional (0 or more) Users
/user@id Optional (0 or 1) Type:String
ID
/user@email Optional (0 or 1) Type:String
Email
/user@name Optional (0 or 1) Type:String
Name
/a Optional (0 or more) Activities
/a@op Required (only 1) Type:String
Operation
/a@ts Required (only 1) Type:long
Timestamp
/a@itemId Required (only 1) Type:String
item-id
/a@ver Optional (0 or 1) Type:Integer
Version
/a@ua Optional (0 or 1) Type:String
User agent
/a@email Optional (0 or 1) Type:String
Email address of user performing action
/a/arg Optional (0 or more) Type:{value}
Extra data for some of the operations
Description for element text content:Value
/a/arg@name Required (only 1) Type:String
Name