Authorization token required | true |
Admin Authorization token required | false |
<ItemActionRequest> ## ItemActionRequest
<action [id="{comma-sep-ids}"] op="{operation}" [tcon="{[-]constraint}"] [tag="{tag} (Integer)"] [l="{folder-id}"]
[rgb="{rgb-color}"] [color="{color} (Byte)"] [name="{name}"] [f="{flags}"] [t="{tags}"] [tn="{tag-names}"]
[nei="{non-existent-ids} (0|1)"] [nci="{newly-created-ids} (0|1)"] /> ## ActionSelector
</ItemActionRequest>
elements and attributes you can define within a
<ItemActionRequest>
element:
XPath | Required / Optional | Description | ||||||||||
/action | Required (only 1) | Specify the action to perform | ||||||||||
/action@id | Optional (0 or 1) | Type: String Comma separated list of item IDs to act on. Required except for TagActionRequest, where the tags items can be specified using their tag names as an alternative. |
||||||||||
/action@op | Required (only 1) | Type: String Operation For ItemAction - delete|dumpsterdelete|recover|read|flag|priority|tag|move|trash|rename|update|color|lock|unlock|resetimapuid|copy For MsgAction - delete|read|flag|tag|move|update|spam|trash For ConvAction - delete|read|flag|priority|tag|move|spam|trash For FolderAction - read|delete|rename|move|trash|empty|color|[!]grant|revokeorphangrants|url|import|sync|fb|[!]check|update|[!]syncon|retentionpolicy|[!]disableactivesync|webofflinesyncdays For TagAction - read|rename|color|delete|update|retentionpolicy For ContactAction - move|delete|flag|trash|tag|update For DistributionListAction - delete delete the list rename rename the list modify modify the list addOwners add list owner removeOwners remove list owners setOwners set list owners grantRights grant rights revokeRights revoke rights setRights set rights addMembers add list members removeMembers remove list members resetimapuid reset IMAP item UIDs |
||||||||||
/action@tcon | Optional (0 or 1) | Type: String List of characters; constrains the set of affected items in a conversation
|
||||||||||
/action@tag | Optional (0 or 1) | Type: Integer Deprecated - use "tn" instead |
||||||||||
/action@l | Optional (0 or 1) | Type: String Folder ID |
||||||||||
/action@rgb | Optional (0 or 1) | Type: String RGB color in format #rrggbb where r,g and b are hex digits |
||||||||||
/action@color | Optional (0 or 1) | Type: Byte color numeric; range 0-127; defaults to 0 if not present; client can display only 0-7 |
||||||||||
/action@name | Optional (0 or 1) | Type: String Name |
||||||||||
/action@f | Optional (0 or 1) | Type: String Flags |
||||||||||
/action@t | Optional (0 or 1) | Type: String Tags - Comma separated list of integers. DEPRECATED - use "tn" instead |
||||||||||
/action@tn | Optional (0 or 1) | Type: String Comma-separated list of tag names |
||||||||||
/action@nei | Optional (0 or 1) | Type: 0|1 Flag to signify that any non-existent ids should be returned |
||||||||||
/action@nci | Optional (0 or 1) | Type: 0|1 Flag to signify that ids of new items should be returned applies to COPY action |
<ItemActionResponse> ## ItemActionResponse
<action id="{success-ids}" op="{operation}" [nei="{non-existent-ids}"] [nci="{newly-created-ids}"] /> ## ActionResult
</ItemActionResponse>
elements and attributes you can define within a
<ItemActionResponse>
element:
XPath | Required / Optional | Description |
/action | Required (only 1) | The <action> element in the response always contains the same id list that the client sent in the request. In particular, IDs that were ignored due to constraints are included in the id list. |
/action@id | Required (only 1) | Type: String Comma-separated list of ids which have been successfully processed |
/action@op | Required (only 1) | Type: String Operation |
/action@nei | Optional (0 or 1) | Type: String Comma-separated list of non-existent ids (if requested) |
/action@nci | Optional (0 or 1) | Type: String Comma-separated list of newly created ids (if requested) |