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

Document Action

Authorization token required true
Admin Authorization token required false

DocumentActionRequest

    <DocumentActionRequest> ## DocumentActionRequest
        <action [zid="{zimbra-id-of-grant-to-revoke}"] [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}"]> ## DocumentActionSelector
            <grant perm="{rights-rwd}" gt="{grant-type-all|pub}" [expiry="{expiry-millis} (Long)"] /> ## DocumentActionGrant
        </action>
    </DocumentActionRequest>

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

XPath Required / Optional Description
/action Required (only 1) Document action selector
Document specific operations : watch|!watch|grant|!grant
/action@zid Optional (0 or 1) Type:String
Zimbra ID of the grant to revoke (Used for "!grant" operation)
/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
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
    acceptSubsReq  accept subscription/un-subscription request
    rejectSubsReq  reject subscription/un-subscription request
 
/action@tcon Optional (0 or 1) Type:String
List of characters; constrains the set of affected items in a conversation
t include items in the Trash
j include items in Spam/Junk
s include items in the user's Sent folder (not necessarily "Sent")
d include items in Drafts folder
o include items in any other folder
A leading '-' means to negate the constraint (e.g. "-t" means all messages not in Trash)
/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/grant Optional (0 or 1) Used for "grant" operation
/action/grant@perm Required (only 1) Type:String
Permissions - (r)ead, (w)rite, (d)elete
/action/grant@gt Required (only 1) Type:String
Grant type - all|pub
/action/grant@expiry Optional (0 or 1) Type:Long
(Optional) Time when this grant expires in milliseconds since the Epoch

DocumentActionResponse

    <DocumentActionResponse> ## DocumentActionResponse
        <action id="{id}" op="{operation}" /> ## IdAndOperation
    </DocumentActionResponse>

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

XPath Required / Optional Description
/action Required (only 1) Details of action
/action@id Required (only 1) Type:String
ID
/action@op Required (only 1) Type:String
Operation