Service: zimbraMail

Command: ImportContacts
Namespace: urn:zimbraMail
Description: Import contacts
Properties:
Authorization token required true
Admin Authorization token required false

ImportContactsRequest

    <ImportContactsRequest ct="{content-type}" [l="{folder-id}"] [csvfmt="{csv-format}"] [csvlocale="{csv-locale}"]> ## ImportContactsRequest
        <content [aid="{attachment-upload-id}"]>{value}</content> ## Content
    </ImportContactsRequest>

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

XPath Required / Optional Description
@ct Required (only 1) Type: String
Content type. Only currenctly supported content type is "csv"
@l Optional (0 or 1) Type: String
Optional Folder ID to import contacts to
@csvfmt Optional (0 or 1) Type: String
The format of csv being imported. when it's not defined, Zimbra format is assumed. the supported formats are defined in $ZIMBRA_HOME/conf/contact-fields.xml
@csvlocale Optional (0 or 1) Type: String
The locale to use when there are multiple {csv-format} locales defined. When it is not specified, the {csv-format} with no locale specification is used.
/content Required (only 1) Type: {value}
Content specification
Description for element text content:Inlined content data. Ignored if "aid" is specified
/content@aid Optional (0 or 1) Type: String
Attachment upload ID of uploaded object to use

ImportContactsResponse

    <ImportContactsResponse> ## ImportContactsResponse
        <cn [n="{num-imported} (long)"] ids="{comma-sep-created-ids}" /> ## ImportContact
    </ImportContactsResponse>

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

XPath Required / Optional Description
/cn Required (only 1) Information about the import process
/cn@n Optional (0 or 1) Type: long
Number imported
/cn@ids Required (only 1) Type: String
Comma-separated list of created IDs