Zimbra REST API Reference:Get Folder
 Article Information |
|---|
| This article applies to the following ZCS versions. |
<< 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}
Go to Command Format
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.
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 "automobile" in the message subject, in XML format:
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=subject:automobile
Retrieve the inbox folder, query for "unread" messages, in XML format:
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=is:unread
Retrieve the inbox folder, query for tag "test", in XML format:
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=tag:test
Retrieve the inbox folder, query for phrase "new automobile" in the message subject, in XML format:
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=subject:"new+automobile"
Retrieve the user-defined folder "mycustomers", in JSON format:
http://localhost:7070/home/john.doe/mycustomers?fmt=json
