Difference between revisions of "Zimbra REST API Reference:Import Contacts"

(HTTP Method)
Line 17: Line 17:
 
=== Formats ===
 
=== Formats ===
  
<code>csv</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Response_Formats|Go to Response Formats]])
+
<code>csv,vcf</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Response_Formats|Go to Response Formats]])
  
 
=== Requires Authentication ===
 
=== Requires Authentication ===
Line 26: Line 26:
  
 
<ul>
 
<ul>
<li><code>fmt</code>. Optional. The response format. Defaults to <code>csv</code>.</li>
+
<li><code>fmt</code>. Required. The import format. Defaults to <code>csv</code>.</li>
<li><code>csvfmt</code>. Optional. If format is <code>csv</code>, optionally select the CSV type which include:
 
<ul>
 
<li>zimbra-csv</li>
 
<li>yahoo-csv</li>
 
<li>thunderbird-csv</li>
 
<li>outlook-2000-csv</li>
 
<li>outlook-2003-csv</li>
 
</ul>
 
</li>
 
<li><code>meta</code>. Optional. If format is <code>tar</code> or <code>tgz</code>, optionally select the CSV type which include. Use <code>meta=1</code> to include meta files, <code>meta=0</code> to not include meta files. If omitted, defaults to <code>meta=1</code>.</li>
 
<li><code>query</code>. Optional. A query keyword.</li>
 
 
</ul>
 
</ul>
  
 
=== Usage Examples ===
 
=== Usage Examples ===
  
Download the contacts as a CSV file:
+
The following examples show using the [http://en.wikipedia.org/wiki/CURL curl] utility to post a file to the REST command. Be sure to replace {username} and {password} with the account username and password.
<pre>
 
http://localhost:7070/home/john.doe/contacts
 
</pre>
 
<pre>
 
http://localhost:7070/home/john.doe/contacts?fmt=csv
 
</pre>
 
 
 
Retrieve the contacts in XML format:
 
<pre>
 
http://localhost:7070/home/john.doe/contacts?fmt=xml
 
</pre>
 
  
Retrieve the contacts in JSON format:
+
Import contacts from CSV format:
 
<pre>
 
<pre>
http://localhost:7070/home/john.doe/contacts?fmt=json
+
curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/contacts?fmt=csv
 
</pre>
 
</pre>
  
Download the contacts as a ZIP file:
+
Import contacts from VCF format:
 
<pre>
 
<pre>
http://localhost:7070/home/john.doe/contacts?fmt=zip
+
curl -{username}:{password} --upload-file /tmp/mycontact.vcf http://localhost:7070/home/john.doe/contacts?fmt=vcf
 
</pre>
 
</pre>
  

Revision as of 15:51, 19 January 2010

<< Back to Zimbra REST API Reference

REST API Method: Import Contacts

Gets the contacts.

URL

http://localhost:7070/home/john.doe/contacts?{params}

HTTP Method

POST

Formats

csv,vcf (Go to Response Formats)

Requires Authentication

true (Go to Authentication)

Parameters

  • fmt. Required. The import format. Defaults to csv.

Usage Examples

The following examples show using the curl utility to post a file to the REST command. Be sure to replace {username} and {password} with the account username and password.

Import contacts from CSV format:

curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/contacts?fmt=csv

Import contacts from VCF format:

curl -{username}:{password} --upload-file /tmp/mycontact.vcf http://localhost:7070/home/john.doe/contacts?fmt=vcf


Verified Against: Zimbra Collaboration Suite 6.0 Date Created: 01/16/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Import_Contacts Date Modified: 2010-01-19



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »


Jump to: navigation, search