Service: zimbraMail

Command: GetImportStatus
Namespace: urn:zimbraMail
Description: Returns current import status for all data sources. Status values for a data source are reinitialized when either (a) another import process is started or (b) when the server is restarted. If import has not run yet, the success and error attributes are not specified in the response.
Properties:
Authorization token required true
Admin Authorization token required false

GetImportStatusRequest

    <GetImportStatusRequest /> ## GetImportStatusRequest

GetImportStatusResponse

    <GetImportStatusResponse> ## GetImportStatusResponse
        List of any of: {
            <imap [id="{datasource-id}"] [isRunning="{is-running} (0|1)"] [success="{success} (0|1)"]
                      [error="{error-message}"] /> ## ImapImportStatusInfo
            <pop3 [id="{datasource-id}"] [isRunning="{is-running} (0|1)"] [success="{success} (0|1)"]
                      [error="{error-message}"] /> ## Pop3ImportStatusInfo
            <caldav [id="{datasource-id}"] [isRunning="{is-running} (0|1)"] [success="{success} (0|1)"]
                        [error="{error-message}"] /> ## CaldavImportStatusInfo
            <yab [id="{datasource-id}"] [isRunning="{is-running} (0|1)"] [success="{success} (0|1)"]
                     [error="{error-message}"] /> ## YabImportStatusInfo
            <rss [id="{datasource-id}"] [isRunning="{is-running} (0|1)"] [success="{success} (0|1)"]
                     [error="{error-message}"] /> ## RssImportStatusInfo
            <gal [id="{datasource-id}"] [isRunning="{is-running} (0|1)"] [success="{success} (0|1)"]
                     [error="{error-message}"] /> ## GalImportStatusInfo
            <cal [id="{datasource-id}"] [isRunning="{is-running} (0|1)"] [success="{success} (0|1)"]
                     [error="{error-message}"] /> ## CalImportStatusInfo
            <unknown [id="{datasource-id}"] [isRunning="{is-running} (0|1)"] [success="{success} (0|1)"]
                         [error="{error-message}"] /> ## UnknownImportStatusInfo
        }
    </GetImportStatusResponse>

elements and attributes you can define within a <GetImportStatusResponse> element:

XPath Required / Optional Description
/imap Optional (0 or 1)
/imap@id Optional (0 or 1) Type: String
Data source ID
/imap@isRunning Optional (0 or 1) Type: 0|1
Whether data is currently being imported from this data source
/imap@success Optional (0 or 1) Type: 0|1
Whether the last import completed successfully. (not returned if the import has not run yet)
/imap@error Optional (0 or 1) Type: String
If the last import failed, this is the error message that was returned. (not returned if the import has not run yet)
/pop3 Optional (0 or 1)
/pop3@id Optional (0 or 1) Type: String
Data source ID
/pop3@isRunning Optional (0 or 1) Type: 0|1
Whether data is currently being imported from this data source
/pop3@success Optional (0 or 1) Type: 0|1
Whether the last import completed successfully. (not returned if the import has not run yet)
/pop3@error Optional (0 or 1) Type: String
If the last import failed, this is the error message that was returned. (not returned if the import has not run yet)
/caldav Optional (0 or 1)
/caldav@id Optional (0 or 1) Type: String
Data source ID
/caldav@isRunning Optional (0 or 1) Type: 0|1
Whether data is currently being imported from this data source
/caldav@success Optional (0 or 1) Type: 0|1
Whether the last import completed successfully. (not returned if the import has not run yet)
/caldav@error Optional (0 or 1) Type: String
If the last import failed, this is the error message that was returned. (not returned if the import has not run yet)
/yab Optional (0 or 1)
/yab@id Optional (0 or 1) Type: String
Data source ID
/yab@isRunning Optional (0 or 1) Type: 0|1
Whether data is currently being imported from this data source
/yab@success Optional (0 or 1) Type: 0|1
Whether the last import completed successfully. (not returned if the import has not run yet)
/yab@error Optional (0 or 1) Type: String
If the last import failed, this is the error message that was returned. (not returned if the import has not run yet)
/rss Optional (0 or 1)
/rss@id Optional (0 or 1) Type: String
Data source ID
/rss@isRunning Optional (0 or 1) Type: 0|1
Whether data is currently being imported from this data source
/rss@success Optional (0 or 1) Type: 0|1
Whether the last import completed successfully. (not returned if the import has not run yet)
/rss@error Optional (0 or 1) Type: String
If the last import failed, this is the error message that was returned. (not returned if the import has not run yet)
/gal Optional (0 or 1)
/gal@id Optional (0 or 1) Type: String
Data source ID
/gal@isRunning Optional (0 or 1) Type: 0|1
Whether data is currently being imported from this data source
/gal@success Optional (0 or 1) Type: 0|1
Whether the last import completed successfully. (not returned if the import has not run yet)
/gal@error Optional (0 or 1) Type: String
If the last import failed, this is the error message that was returned. (not returned if the import has not run yet)
/cal Optional (0 or 1)
/cal@id Optional (0 or 1) Type: String
Data source ID
/cal@isRunning Optional (0 or 1) Type: 0|1
Whether data is currently being imported from this data source
/cal@success Optional (0 or 1) Type: 0|1
Whether the last import completed successfully. (not returned if the import has not run yet)
/cal@error Optional (0 or 1) Type: String
If the last import failed, this is the error message that was returned. (not returned if the import has not run yet)
/unknown Optional (0 or 1)
/unknown@id Optional (0 or 1) Type: String
Data source ID
/unknown@isRunning Optional (0 or 1) Type: 0|1
Whether data is currently being imported from this data source
/unknown@success Optional (0 or 1) Type: 0|1
Whether the last import completed successfully. (not returned if the import has not run yet)
/unknown@error Optional (0 or 1) Type: String
If the last import failed, this is the error message that was returned. (not returned if the import has not run yet)