Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
ModifySystemRetentionPolicy SOAP Command

Modify system retention policy

Authorization token required true
Admin Authorization token required true

ModifySystemRetentionPolicyRequest

    <ModifySystemRetentionPolicyRequest> ## ModifySystemRetentionPolicyRequest
        <cos [by="{cos-selector-by} (id|name)"]>{key}</cos> ## CosSelector
        <policy [type="{retention-policy-type} (user|system)"] [id="{id}"] [name="{name}"] [lifetime="{policy-duration}"] /> ## Policy
    </ModifySystemRetentionPolicyRequest>

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

XPath Required / Optional Description
/cos Optional (0 or 1) Type:{key}
COS
Description for element text content:The key used to identify the COS. Meaning determined by {cos-selector-by}
/cos@by Optional (0 or 1) Type:id|name
Select the meaning of {cos-selector-key}
/policy Required (only 1) New policy
/policy@type Optional (0 or 1) Type:user|system
Retention policy type
/policy@id Optional (0 or 1) Type:String
ID
/policy@name Optional (0 or 1) Type:String
Name
/policy@lifetime Optional (0 or 1) Type:String
Duration

ModifySystemRetentionPolicyResponse

    <ModifySystemRetentionPolicyResponse> ## ModifySystemRetentionPolicyResponse
        <policy [type="{retention-policy-type} (user|system)"] [id="{id}"] [name="{name}"] [lifetime="{policy-duration}"] /> ## Policy
    </ModifySystemRetentionPolicyResponse>

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

XPath Required / Optional Description
/policy Required (only 1) Information about retention policy
/policy@type Optional (0 or 1) Type:user|system
Retention policy type
/policy@id Optional (0 or 1) Type:String
ID
/policy@name Optional (0 or 1) Type:String
Name
/policy@lifetime Optional (0 or 1) Type:String
Duration