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

(Usage Examples)
(Folder Name)
Line 17: Line 17:
 
=== Folder Name ===
 
=== Folder Name ===
  
<code>{folder-name}</code>. The name of the mail folder to access. Must be specified and possible values include:
+
<code>{folder-name}</code>. The name of the mail folder to access. This can be a default or a user-defined folder. Default folders include:
  
 
<ul>
 
<ul>
Line 25: Line 25:
 
<li><code>trash</code>. The trash folder.</li>
 
<li><code>trash</code>. The trash folder.</li>
 
<li><code>junk</code>. The junk/spam folder.</li>
 
<li><code>junk</code>. The junk/spam folder.</li>
<li>A user-defined folder name.</li>
 
 
</ul>
 
</ul>
  

Revision as of 16:18, 19 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}

HTTP Method

GET

Folder Name

{folder-name}. The name of the mail folder to access. This can be a default or a user-defined folder. Default folders 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,zip,tar,tgz (Go to Response Formats)

Note: When using the zip,tar,tgz formats, the mail messages are packaged in the archive as .eml files (i.e. plain text in MIME format).

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 user-defined folder "mycustomers", in JSON format:

http://localhost:7070/home/john.doe/mycustomers?fmt=json


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



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