Zimbra REST API Reference:Get Item: Difference between revisions
(Adding categories) |
|||
Line 101: | Line 101: | ||
{{Article Footer|Zimbra Collaboration Suite 6.0|01/16/2010}} | {{Article Footer|Zimbra Collaboration Suite 6.0|01/16/2010}} | ||
[[Media:Example.ogg]] | [[Media:Example.ogg]] | ||
[[Category:REST]] | |||
[[Category:ZCS 6.0]] |
Revision as of 19:01, 21 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}
HTTP Method
GET
Item Id
id={item-id}
. Required. Specifies the item id to retrieve.
Formats
Type | Formats | Default Format | Comments |
Mail Message | json,xml,rss,atom,zip,tar,tgz,sync
|
Defaults to MIME (RFC822).
|
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 RFC822 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 message id.fmt
. Optional. The response format.
Mail Message Parameters
imap_id
. Optional. Specify an IMAP id in lieu of a message id.part
. Optional. Specify which part of the MIME message to retrieve.
Usage Examples
Retrieve the mail message (with id 288) as MIME RFC822 format:
http://localhost:7070/home/john.doe/?id=288
Download the mail message (with id 553) attachment (in part 2 of the message):
http://localhost:7070/home/john.doe/?id=288&part=2
Retrieve the contact (with id 272) in XML format:
http://localhost:7070/home/john.doe/?id=272&fmt=xml
Retrieve the appointment (with id 506) in ICS format:
http://localhost:7070/home/john.doe/?id=506
Retrieve the task (with id 582) in ICS format:
http://localhost:7070/home/john.doe/?id=582