Zimbra REST API Reference:Get Folder

Revision as of 03:45, 11 February 2010 by Sposetti (talk | contribs) (→‎URL)

<< Back to Zimbra REST API Reference

REST API Method: Get Folder

Gets the items in the folder.



Go to Command Format

HTTP Method


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.


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)


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

Usage Examples

Retrieve the inbox folder in RSS format:


Retrieve the inbox folder in XML format:


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


Retrieve the inbox folder, query for "automobile" in the message subject, in XML format:


Retrieve the inbox folder, query for "unread" messages, in XML format:


Retrieve the inbox folder, query for tag "test", in XML format:


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


Retrieve the user-defined folder "mycustomers", in JSON format:


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-02-11

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