Overview | Service | Command |
Send share notification
The client can list the recipient email addresses for the share, along with the itemId of the item being shared.
Authorization token required | true |
Admin Authorization token required | false |
<SendShareNotificationRequest [action="{action} (edit|revoke|expire)"]> ## SendShareNotificationRequest
<item [id="..."] /> ## Id
(<e a="{email-addr}" [t="{address-type}"] [p="{personal-name}"] /> ## EmailAddrInfo)*
<notes>{notes} (String)</notes>
</SendShareNotificationRequest>
The following table describes elements and attributes you can define within a
<SendShareNotificationRequest>
element:
XPath | Required / Optional | Description |
@action | Optional (0 or 1) | Type:edit|revoke|expire Set to "revoke" if it is a grant revoke notification. It is set to "expire" by the system to send notification for a grant expiry. |
/item | Optional (0 or 1) | Item ID |
/item@id | Optional (0 or 1) | Type:String ID |
/e | Optional (0 or more) | Email addresses |
/e@a | Required (only 1) | Type:String Email address |
/e@t | Optional (0 or 1) | Type:String Optional Address type - (f)rom, (t)o, (c)c, (b)cc, (r)eply-to, (s)ender, read-receipt (n)otification, (rf) resent-from |
/e@p | Optional (0 or 1) | Type:String The comment/name part of an address |
/notes | Optional (0 or 1) | Type:{notes} (String) Notes |
<SendShareNotificationResponse /> ## SendShareNotificationResponse