Zimbra REST API Reference:Get Item: Difference between revisions
Line 62: | Line 62: | ||
<ul> | <ul> | ||
<li><code>imap_id</code>. Optional. Specified an IMAP id in lieu of a message id.</li> | |||
<li><code>part</code>. Optional. Specified which part of the MIME message to retrieve.</li> | <li><code>part</code>. Optional. Specified which part of the MIME message to retrieve.</li> | ||
</ul> | </ul> |
Revision as of 23:17, 17 January 2010
<< Back to Zimbra REST API Reference
REST API Method: Get Item
Gets an item.
URL
http://localhost:7070/home/john.doe/?id={item-id}&{params}
Item Id
{item-id}
. Required. Specifies the item id.
Formats
Type | Formats | Default Format | Comments |
Mail Message | json,xml,rss,atom,zip,tar,tgz,sync
|
Defaults to MIME .
|
When using the zip,tar,tgz formats, the mail message is packaged in the archive as a .eml file (i.e. plain text in MIME format).
|
Appointment | json,xml,ics
|
Defaults to iCalendar format(.ics ).
|
|
Contact | json,xml,vcf
|
Defaults to vCard format (.vcf ).
|
|
Task | json,xml,ics,rss,atom
|
Defaults to iCalendar format(.ics ).
|
See Response Formats for more information.
Requires Authentication
true
(Go to Authentication)
Parameters
id
. Required. The item id.fmt
. Optional. The response format.
Mail Message Parameters
imap_id
. Optional. Specified an IMAP id in lieu of a message id.part
. Optional. Specified which part of the MIME message to retrieve.
Usage Examples
Download the contacts as a CSV file:
http://localhost:7070/home/john.doe/contacts
http://localhost:7070/home/john.doe/contacts?fmt=csv
Retrieve the contacts in XML format:
http://localhost:7070/home/john.doe/contacts?fmt=xml
Retrieve the contacts in JSON format:
http://localhost:7070/home/john.doe/contacts?fmt=json
Download the contacts as a ZIP file:
http://localhost:7070/home/john.doe/contacts?fmt=zip