Zimbra REST API Reference

Revision as of 21:17, 16 January 2010 by Sposetti (talk | contribs) (Response Formats)

Zimbra exposes its data via a REST API. This document is the reference for that functionality.

REST (REpresentational State Transfer) is an approach for building application services that make resources available via a URL. For example, the following REST command retrieves all inbox items as a simple RSS feed:

http://localhost:7070/home/user1/inbox.rss

Learn more about REST at the Wikipedia article Representational State Transfer.

Overview

Command Format

The format of a Zimbra REST command is:

{protocol}://{host}:{port}/home/{user}/{object}?{params} 

The following describes the components of the REST command:

Component Description
protocol The transport protocol, for example, http.
host The host name or IP address of the Zimbra Collaboration Suite server
port The port number, for example, 7070.
user The user. To load an explicit user account, specify the user in one of the following formats:
  • john.doe
    http://localhost:7070/home/john.doe/inbox.rss
    
  • john.doe@mydomain.com
  • http://localhost:7070/home/john.doe@mydomain.com/inbox.rss
    

You can also use "~" as a shortcut to the current user. For example:

http://localhost:7070/home/~/inbox.rss
object Designates the object to perform the command against. This might be a folder (such as inbox or drafts) or omitted (to download a specific item). If omitted, the query parameters will provide the information the command requires.

For example, to download the inbox folder as XML:

http://localhost:7070/home/john.doe/inbox.rss

For example, to download an item:

http://localhost:7070/home/john.doe/?id=657
params A list of command-specific URL parameters. See the specific command for a list of the required and optional parameters.

Response Formats

The following describes the various response formats. Not all command support all formats. See your specific command for a list of supported formats:

Format Description
xml The transport protocol, for example, http.
json The host name or IP address of the Zimbra Collaboration Suite server
rss

atom

The port number, for example, 7070.
html The port number, for example, 7070.
zip The port number, for example, 7070.
tar The port number, for example, 7070.
tgz The port number, for example, 7070.
ics iCalendar. See the Wikipedia article [1]
csv Common Separated Values

Authentication

XYZ

Methods

The API supports the following methods to retrieve Zimbra data.

Mail Methods

Get Folder

Address Book Methods

Get Contacts

Calendar Methods

Get Calendar

Item Methods

Get Item
Get Attachment


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



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