Zimbra REST API Reference: Difference between revisions

No edit summary
Line 82: Line 82:
The API supports the following methods to retrieve Zimbra data.
The API supports the following methods to retrieve Zimbra data.

=== Folder Methods ===
=== Mail Methods ===

[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Inbox|Get Inbox]]
[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Inbox|Get Folder]]
[[ZCS_6.0:Zimbra REST API Reference:Get_Drafts|Get Drafts]]
[[ZCS_6.0:Zimbra REST API Reference:Get_Sent|Get Sent]]
[[ZCS_6.0:Zimbra REST API Reference:Get_Trash|Get Trash]]
[[ZCS_6.0:Zimbra REST API Reference:Get_Folder|Get Folder]]

Revision as of 19:38, 16 January 2010

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:


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


Command Format

The format of a Zimbra REST command is:


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
  • 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:

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:


For example, to download an item:

params A list of command-specific URL parameters. See the specific command for a list of the required and optional parameters.

Response Formats





The API supports the following methods to retrieve Zimbra data.

Mail Methods

Get Folder

Jump to: navigation, search