Zimbra REST API: Item Methods

In this article we are going to analyze the Item methods of the Zimbra REST API. For an overview and in-depth coverage about it, we refer you to the related article in our technical blog.

Get Item

This method retrieves items. The HTTP method to read data is get.

The basic URL structure is the following one:

http(s)://<host>/home/sample.user/?id={item-id}&{params}

Item Id

This method requires the id of the item to be retrieved: id={item-id}.

Formats

The supported formats vary depending on the type of object being recovered. Below is a table that summarizes the different types to choose from:

TypeFormatsDefault Format
e-mail Messagejson, xml, rss, atom, zip, tar, tgz, syncDefault format is MIME
Appointmentjson, xml, icsDefault format is ics
Contactjson, xml, vcfDefault format is vcf
Taskjson, xml, ics, rss, atomDefault format is ics

Parameters

We have different parameters for this method. The basic ones are:

  • id – the message id is required.
  • fmt – the reply format is optional.

There are also two Mail Message Parameters, both optional:

  • imap_id – this specifies an IMAP id
  • part – this specifies which part of the MIME message to retrieve.

Examples

To retrieve an email message with id 55 as default MIME RFC822 format:

https://mail.sampledomain.com/home/james.red/?id=55

If you want to retrieve the contact with id 712 in XML format:

https://mail.sampledomain.com/home/james.red/?id=712&fmt=xml

Technical writer at Zextras. Linux and technology enthusiast. He describes himself as an atypical and polyhedric IT expert, thanks to a creative and open minded attitude, and to the experience gained over time as an IT technician, system engineer and developer.

Post your comment