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

Triggers the specified data sources to kick off their import processes. Data import runs asynchronously, so the response immediately returns. Status of an import can be queried via the <GetImportStatusRequest> message. If the server receives an <ImportDataRequest> while an import is already running for a given data source, the second request is ignored.

Authorization token required true
Admin Authorization token required false

ImportDataRequest

    <ImportDataRequest> ## ImportDataRequest
        List of any of: {
            <imap [name="{name}"] [id="{id}"] /> ## ImapDataSourceNameOrId
            <pop3 [name="{name}"] [id="{id}"] /> ## Pop3DataSourceNameOrId
            <caldav [name="{name}"] [id="{id}"] /> ## CaldavDataSourceNameOrId
            <yab [name="{name}"] [id="{id}"] /> ## YabDataSourceNameOrId
            <rss [name="{name}"] [id="{id}"] /> ## RssDataSourceNameOrId
            <gal [name="{name}"] [id="{id}"] /> ## GalDataSourceNameOrId
            <cal [name="{name}"] [id="{id}"] /> ## CalDataSourceNameOrId
            <unknown [name="{name}"] [id="{id}"] /> ## UnknownDataSourceNameOrId
        }
    </ImportDataRequest>

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

XPath Required / Optional Description
/imap Optional (0 or 1)
/imap@name Optional (0 or 1) Type:String
Name
/imap@id Optional (0 or 1) Type:String
ID
/pop3 Optional (0 or 1)
/pop3@name Optional (0 or 1) Type:String
Name
/pop3@id Optional (0 or 1) Type:String
ID
/caldav Optional (0 or 1)
/caldav@name Optional (0 or 1) Type:String
Name
/caldav@id Optional (0 or 1) Type:String
ID
/yab Optional (0 or 1)
/yab@name Optional (0 or 1) Type:String
Name
/yab@id Optional (0 or 1) Type:String
ID
/rss Optional (0 or 1)
/rss@name Optional (0 or 1) Type:String
Name
/rss@id Optional (0 or 1) Type:String
ID
/gal Optional (0 or 1)
/gal@name Optional (0 or 1) Type:String
Name
/gal@id Optional (0 or 1) Type:String
ID
/cal Optional (0 or 1)
/cal@name Optional (0 or 1) Type:String
Name
/cal@id Optional (0 or 1) Type:String
ID
/unknown Optional (0 or 1)
/unknown@name Optional (0 or 1) Type:String
Name
/unknown@id Optional (0 or 1) Type:String
ID

ImportDataResponse

    <ImportDataResponse /> ## ImportDataResponse