Difference between revisions of "Zimbra REST API Reference"

(Command Format)
(Command Format)
Line 25: Line 25:
 
|-
 
|-
 
|<code>protocol</code>
 
|<code>protocol</code>
|
+
|The transport protocol, for example, <code>http</code>.
 
|-
 
|-
 
|<code>host</code>
 
|<code>host</code>
|
+
|The host name or IP address of the Zimbra Collaboration Suite server
 
|-
 
|-
 
|<code>port</code>
 
|<code>port</code>
|
+
|The port number, for example, 7070.
 
|-
 
|-
 
|<code>user</code>
 
|<code>user</code>
|
+
|The user. To load an explicit user account, specify the user in one of the following formats:
 +
<ul>
 +
<li>john.doe</li>
 +
<li>john.doe@mydomain.com</li>
 +
</ul>
 +
Note: Use "~" as shortcut to the currently authenticated user. For example:
 +
<pre>
 +
http://localhost:7070/home/~/inbox.rss
 +
</pre>
 +
 
|-
 
|-
 
|<code>object</code>
 
|<code>object</code>

Revision as of 18:51, 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:

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

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


Command Format

The format of a Zimbra REST command is:

{protocol}://{host}:{port}/home/{user}/{object}?{query-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
  • john.doe@mydomain.com

Note: Use "~" as shortcut to the currently authenticated user. For example:

http://localhost:7070/home/~/inbox.rss
object
query-params

Common Parameters

Methods

The API supports the following methods to retrieve Zimbra data.

Folder Methods

Get Inbox

Get Drafts

Get Sent

Get Trash

Get Folder

Item Methods

Searching

Jump to: navigation, search