Service: zimbraAdminExt
Namespace: "urn:zimbraAdminExt"
BulkImportAccounts SOAP Command

Import accounts in bulk

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

BulkImportAccountsRequest

    <BulkImportAccountsRequest [op="{operation}"]> ## BulkImportAccountsRequest
        <createDomains>{createDomains} (String)</createDomains>
        <SMTPHost>{SMTPHost} (String)</SMTPHost>
        <SMTPPort>{SMTPPort} (String)</SMTPPort>
        <sourceType>{sourceType} (String)</sourceType>
        <aid>{attachmentID} (String)</aid>
        <password>{password} (String)</password>
        <genPasswordLength>{genPasswordLength} (Integer)</genPasswordLength>
        <generatePassword>{generatePassword} (String)</generatePassword>
        <maxResults>{maxResults} (Integer)</maxResults>
        <mustChangePassword>{mustChangePassword} (String)</mustChangePassword>
        (<a name="{attr-name}">{value}</a> ## Attr)*
    </BulkImportAccountsRequest>

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

XPath Required / Optional Description
@op Optional (0 or 1) Type:String
Operation - preview|startImport|abortImport|getStatus
/createDomains Required (only 1) Type:{createDomains} (String)
Create domains if value is "true" (case insensitive) else false
/SMTPHost Optional (0 or 1) Type:{SMTPHost} (String)
SMTP hostname
/SMTPPort Optional (0 or 1) Type:{SMTPPort} (String)
SMTP port
/sourceType Optional (0 or 1) Type:{sourceType} (String)
Source type
/aid Optional (0 or 1) Type:{attachmentID} (String)
Attachment ID
/password Optional (0 or 1) Type:{password} (String)
Password
/genPasswordLength Optional (0 or 1) Type:{genPasswordLength} (Integer)
Password length for generated passwords
/generatePassword Optional (0 or 1) Type:{generatePassword} (String)
Flags whether to generate passwords. Ttrue if "true" (case insensitive) else false - default value "false"
/maxResults Optional (0 or 1) Type:{maxResults} (Integer)
Maximum number of results
/mustChangePassword Required (only 1) Type:{mustChangePassword} (String)
Flags whether user must change the password. True if "true" (case insensitive) else false
/a Optional (0 or more) Type:{value}
Attrs
Description for element text content:Attribute Value
/a@name Required (only 1) Type:String
Attribute name

BulkImportAccountsResponse

    <BulkImportAccountsResponse> ## BulkImportAccountsResponse
        <totalCount>{totalCount} (Integer)</totalCount>
        <skippedAccountCount>{skippedAccountCount} (Integer)</skippedAccountCount>
        <SMTPHost>{SMTPHost} (String)</SMTPHost>
        <SMTPPort>{SMTPPort} (String)</SMTPPort>
        <status>{status} (Integer)</status>
        <provisionedCount>{provisionedCount} (Integer)</provisionedCount>
        <skippedCount>{skippedCount} (Integer)</skippedCount>
        <errorCount>{errorCount} (Integer)</errorCount>
        <fileToken>{reportFileToken} (String)</fileToken>
    </BulkImportAccountsResponse>

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

XPath Required / Optional Description
/totalCount Optional (0 or 1) Type:{totalCount} (Integer)
Total count
/skippedAccountCount Optional (0 or 1) Type:{skippedAccountCount} (Integer)
Count of number of skipped accounts
/SMTPHost Optional (0 or 1) Type:{SMTPHost} (String)
SMTP host
/SMTPPort Optional (0 or 1) Type:{SMTPPort} (String)
SMTP port
/status Optional (0 or 1) Type:{status} (Integer)
Status
/provisionedCount Optional (0 or 1) Type:{provisionedCount} (Integer)
Provisioned count
/skippedCount Optional (0 or 1) Type:{skippedCount} (Integer)
Skipped count
/errorCount Optional (0 or 1) Type:{errorCount} (Integer)
Error count
/fileToken Optional (0 or 1) Type:{reportFileToken} (String)
Report file token