| Authorization token required | true |
| Admin Authorization token required | false |
<TagActionRequest> ## TagActionRequest
<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)"]> ## TagActionSelector
<retentionPolicy> ## RetentionPolicy
<purge>
(<policy [type="{retention-policy-type} (user | system)"] [id="{id}"] [name="{name}"]
[lifetime="{policy-duration}"] /> ## Policy)*
</purge>
</retentionPolicy>
</action>
</TagActionRequest>
elements and attributes you can define within a
<TagActionRequest> element:
| XPath | Required / Optional | Description | ||||||||||
| /action | Required (only 1) | Specify action to perform.
Caller must supply one of "id" or "tn" Supported operations: "read|!read|color|delete|rename|update|retentionpolicy" If op="update", the caller can specify "name" and/or "color" |
||||||||||
| /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 |
||||||||||
| /action/retentionPolicy | Optional (0 or 1) | Retention policy | ||||||||||
| /action/retentionPolicy/purge | Required (only 1) | |||||||||||
| /action/retentionPolicy/purge/policy | Optional (0 or more) | |||||||||||
| /action/retentionPolicy/purge/policy@type | Optional (0 or 1) | Type: user | system Retention policy type |
||||||||||
| /action/retentionPolicy/purge/policy@id | Optional (0 or 1) | Type: String ID |
||||||||||
| /action/retentionPolicy/purge/policy@name | Optional (0 or 1) | Type: String Name |
||||||||||
| /action/retentionPolicy/purge/policy@lifetime | Optional (0 or 1) | Type: String Duration |
<TagActionResponse> ## TagActionResponse
<action id="{tag-ids}" [tn="{tag-names}"] op="{operation}" /> ## TagActionInfo
</TagActionResponse>
elements and attributes you can define within a
<TagActionResponse> element:
| XPath | Required / Optional | Description |
| /action | Required (only 1) | The <action> element contains information about the tags affected by the operation if and only if the operation was successful |
| /action@id | Required (only 1) | Type: String Tag IDs for successfully applied operation |
| /action@tn | Optional (0 or 1) | Type: String Names of tags affected by successfully applied operation Only present if "tn" was specified in the request |
| /action@op | Required (only 1) | Type: String Operation - "read|!read|color|delete|rename|update|retentionpolicy" |