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

Get system retention policy

Authorization token required true
Admin Authorization token required false

GetSystemRetentionPolicyRequest

    <GetSystemRetentionPolicyRequest /> ## GetSystemRetentionPolicyRequest

GetSystemRetentionPolicyResponse

    <GetSystemRetentionPolicyResponse> ## GetSystemRetentionPolicyResponse
        <retentionPolicy> ## RetentionPolicy
            <keep>
                (<policy [type="{retention-policy-type} (user|system)"] [id="{id}"] [name="{name}"]
                             [lifetime="{policy-duration}"] /> ## Policy)*
            </keep>
            <purge>
                (<policy ... /> ## See /retentionPolicy/keep/policy [ ## Policy])*
            </purge>
         </retentionPolicy>
    </GetSystemRetentionPolicyResponse>

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

XPath Required / Optional Description
/retentionPolicy Optional (0 or 1) System Retention policy
/retentionPolicy/keep Required (only 1)
/retentionPolicy/keep/policy Optional (0 or more)
/retentionPolicy/keep/policy@type Optional (0 or 1) Type:user|system
Retention policy type
/retentionPolicy/keep/policy@id Optional (0 or 1) Type:String
ID
/retentionPolicy/keep/policy@name Optional (0 or 1) Type:String
Name
/retentionPolicy/keep/policy@lifetime Optional (0 or 1) Type:String
Duration
/retentionPolicy/purge Required (only 1)
/retentionPolicy/purge/policy Optional (0 or more) See /retentionPolicy/keep/policy for more details.