Zimbra REST API Reference:Get Folder
<< 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
Specifies the mail folder to access and must be specified. Values include:
inbox
. The inbox folder.drafts
. The drafts folder.sent
. The sent items folder.trash
. The trash folder.junk
. The junk/spam folder.{custom folder}
. The folder name.
Formats
xml,json,rss,tar,tgz,zip
Go to "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, query for phrase "new automobile", in XML format:
http://localhost:7070/home/john.doe/mycustomers?fmt=xml&query="new+automobile"