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

Import data for multiple accounts via IMAP

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

BulkIMAPDataImportRequest

    <BulkIMAPDataImportRequest [op="{operation}"]> ## BulkIMAPDataImportRequest
        <sourceType>{sourceType} (String)</sourceType>
        <aid>{attachmentID} (String)</aid>
        (<account name="{name}" /> ## Name)*
        <ConnectionType>{connectionType} (String)</ConnectionType>
        <sourceServerType>{sourceServerType} (String)</sourceServerType>
        <IMAPHost>{IMAPHost} (String)</IMAPHost>
        <IMAPPort>{IMAPPort} (String)</IMAPPort>
        <indexBatchSize>{indexBatchSize} (String)</indexBatchSize>
        <UseAdminLogin>{useAdminLogin} (String)</UseAdminLogin>
        <IMAPAdminLogin>{IMAPAdminLogin} (String)</IMAPAdminLogin>
        <IMAPAdminPassword>{IMAPAdminPassword} (String)</IMAPAdminPassword>
    </BulkIMAPDataImportRequest>

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

XPath Required / Optional Description
@op Optional (0 or 1) Type:String
Operation - preview|startImport|dismissImport
/sourceType Optional (0 or 1) Type:{sourceType} (String)
Source type - bulkxml|zimbra
/aid Optional (0 or 1) Type:{attachmentID} (String)
Uploaded attachment ID
/account Optional (0 or more) Account specification - where name attributes are email addresses
/account@name Required (only 1) Type:String
Name
/ConnectionType Optional (0 or 1) Type:{connectionType} (String)
Connection type
/sourceServerType Optional (0 or 1) Type:{sourceServerType} (String)
Source server type
/IMAPHost Optional (0 or 1) Type:{IMAPHost} (String)
IMAP hostname
/IMAPPort Optional (0 or 1) Type:{IMAPPort} (String)
IMAP port
/indexBatchSize Optional (0 or 1) Type:{indexBatchSize} (String)
Index batch size
/UseAdminLogin Optional (0 or 1) Type:{useAdminLogin} (String)
Flag to choose whether to use Admin login or not. Set to "1" to set. Default is false
/IMAPAdminLogin Optional (0 or 1) Type:{IMAPAdminLogin} (String)
IMAP Admin login name
/IMAPAdminPassword Optional (0 or 1) Type:{IMAPAdminPassword} (String)
IMAP Admin password

BulkIMAPDataImportResponse

    <BulkIMAPDataImportResponse> ## BulkIMAPDataImportResponse
        <runningAccounts>
            (<account name="{name}" id="{id}" /> ## NameId)*
        </runningAccounts>
        <totalCount>{totalCount} (Integer)</totalCount>
        <idleCount>{idleCount} (Integer)</idleCount>
        <runningCount>{runningCount} (Integer)</runningCount>
        <finishedCount>{finishedCount} (Integer)</finishedCount>
        <ConnectionType>{connectionType} (String)</ConnectionType>
        <IMAPHost>{IMAPHost} (String)</IMAPHost>
        <IMAPPort>{IMAPPort} (String)</IMAPPort>
        <indexBatchSize>{indexBatchSize} (String)</indexBatchSize>
        <UseAdminLogin>{useAdminLogin} (Integer)</UseAdminLogin>
        <IMAPAdminLogin>{IMAPAdminLogin} (String)</IMAPAdminLogin>
        <IMAPAdminPassword>{IMAPAdminPassword} (String)</IMAPAdminPassword>
    </BulkIMAPDataImportResponse>

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

XPath Required / Optional Description
/runningAccounts Required (only 1)
/runningAccounts/account Optional (0 or more)
/runningAccounts/account@name Required (only 1) Type:String
name
/runningAccounts/account@id Required (only 1) Type:String
ID
/totalCount Optional (0 or 1) Type:{totalCount} (Integer)
Total count
/idleCount Optional (0 or 1) Type:{idleCount} (Integer)
Idle count
/runningCount Optional (0 or 1) Type:{runningCount} (Integer)
Running count
/finishedCount Optional (0 or 1) Type:{finishedCount} (Integer)
Finished count
/ConnectionType Optional (0 or 1) Type:{connectionType} (String)
Connection type
/IMAPHost Optional (0 or 1) Type:{IMAPHost} (String)
IMAP hostname
/IMAPPort Optional (0 or 1) Type:{IMAPPort} (String)
IMAP port
/indexBatchSize Optional (0 or 1) Type:{indexBatchSize} (String)
Index batch size
/UseAdminLogin Optional (0 or 1) Type:{useAdminLogin} (Integer)
Whether Admin login is in use or not. "1" means true, "0" means false
/IMAPAdminLogin Optional (0 or 1) Type:{IMAPAdminLogin} (String)
IMAP Admin login name
/IMAPAdminPassword Optional (0 or 1) Type:{IMAPAdminPassword} (String)
IMAP Admin password