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

Create an archive

Network edition only API TRUE
Authorization token required true
Admin Authorization token required true

CreateArchiveRequest

    <CreateArchiveRequest> ## CreateArchiveRequest
        <account by="{acct-selector-by} (adminName|appAdminName|id|foreignPrincipal|name|krb5Principal)">{key}</account> ## AccountSelector
        <archive [create="{create-archive-account-flag} (0|1)"]> ## ArchiveSpec
            <name>{name} (String)</name>
            <cos [by="{cos-selector-by} (id|name)"]>{key}</cos> ## CosSelector
            <password>{password} (String)</password>
            (<a n="{key}" /> ## Attr)*
         </archive>
    </CreateArchiveRequest>

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

XPath Required / Optional Description
/account Required (only 1) Type:{key}
Account
Description for element text content:The key used to identify the account. Meaning determined by {acct-selector-by}
/account@by Required (only 1) Type:adminName|appAdminName|id|foreignPrincipal|name|krb5Principal
Select the meaning of {acct-selector-key}
/archive Optional (0 or 1) Archive details
/archive@create Optional (0 or 1) Type:0|1
for <EnableArchiveRequest>, Archive account is created by default based on name templates. You can suppress this by setting this flag to 0 (false). This is useful if you are going to use a third party system to do the archiving and ZCS is just a mail forker.
/archive/name Optional (0 or 1) Type:{name} (String)
Archive account name. If not specified, archive account name is computed based on name templates.
/archive/cos Optional (0 or 1) Type:{key}
Selector for Class Of Service (COS)
Description for element text content:The key used to identify the COS. Meaning determined by {cos-selector-by}
/archive/cos@by Optional (0 or 1) Type:id|name
Select the meaning of {cos-selector-key}
/archive/password Optional (0 or 1) Type:{password} (String)
Archive account password - Recommended that password not be specified so only admins can login
/archive/a Optional (0 or more) Attributes
/archive/a@n Required (only 1) Type:String
Key

CreateArchiveResponse

    <CreateArchiveResponse /> ## CreateArchiveResponse