Difference between revisions of "Zimbra REST API Reference"

(Mail Methods)
Line 85: Line 85:
  
 
[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Folder|Get Folder]]
 
[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Folder|Get Folder]]
 +
 +
=== Address Book Methods ===
 +
 +
[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Contacts|Get Contacts]]
 +
 +
=== Calendar Methods ===
 +
 +
[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Calendar|Get Calendar]]
 +
 +
=== Item Methods ===
 +
 +
[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Item|Get Item]]
 +
[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Attachment|Get Attachment]]
 +
 +
 +
{{Article Footer|Zimbra Collaboration Suite 6.0|12/22/2009}}

Revision as of 19:52, 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.

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

XYZ

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: 12/22/2009
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