Difference between revisions of "Zimbra REST API Reference:Get Folder"

(Requires Authentication)
(Formats)
Line 26: Line 26:
 
=== Formats ===
 
=== Formats ===
  
<code>xml,json,rss,tar,tgz,zip</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Formats|Go to Formats]])
+
<code>xml,json,rss,tar,tgz,zip</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Response_Formats|Go to Response Formats]])
  
 
=== Requires Authentication ===
 
=== Requires Authentication ===

Revision as of 19:47, 16 January 2010

<< Back to Zimbra REST API Reference


REST API Method: Get Folder

Gets the items in the folder.

URL

http://localhost:7070/home/john.doe/{folder-name}?{params}

Folder Name

The name of the mail folder to access. Must be specified and possible values include:

  • inbox. The inbox folder.
  • drafts. The drafts folder.
  • sent. The sent items folder.
  • trash. The trash folder.
  • junk. The junk/spam folder.

Formats

xml,json,rss,tar,tgz,zip (Go to Response Formats)

Requires Authentication

true (Go to Authentication)

Parameters

  • fmt. Required. The response format.
  • query. Optional. A query string or keywords.

Usage Examples

Retrieve the inbox folder in RSS format:

http://localhost:7070/home/john.doe/inbox?fmt=rss

Retrieve the inbox folder in XML format:

http://localhost:7070/home/john.doe/inbox?fmt=xml

Retrieve the drafts folder, query for keyword "automobile", in XML format:

http://localhost:7070/home/john.doe/drafts?fmt=xml&query=automobile

Retrieve the inbox folder, query for keywords "automobile" and "highway", in XML format:

http://localhost:7070/home/john.doe/inbox?fmt=xml&query=automobile+highway

Retrieve the inbox folder, query for phrase "new automobile", in XML format:

http://localhost:7070/home/john.doe/inbox?fmt=xml&query="new+automobile"

Retrieve the mycustomers folder, in JSON format:

http://localhost:7070/home/john.doe/mycustomers?fmt=json
Jump to: navigation, search