Difference between revisions of "Zimbra REST API Reference:Get Item"

(Usage Examples)
(REST API Method: Get Item)
Line 100: Line 100:
  
 
{{Article Footer|Zimbra Collaboration Suite 6.0|01/16/2010}}
 
{{Article Footer|Zimbra Collaboration Suite 6.0|01/16/2010}}
 +
[[Media:Example.ogg]]

Revision as of 09:37, 20 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


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:Get_Item Date Modified: 2010-01-20



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 »


Media:Example.ogg

Jump to: navigation, search