Zimbra REST API Reference:Get Folder: Difference between revisions
(Adding Article Infobox and category) |
(Adding Tabs Templates) |
||
Line 1: | Line 1: | ||
{{Template:TabHeader}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference|Introduction]]}} | |||
{{Template:Tab1|[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Folder|Method: Get Folder]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Import_Message|Method: Import Message]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Contacts|Method: Get Contacts]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Import_Contacts|Method: Import Contacts]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Calendar|Method: Get Calendar]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Get_FreeBusy|Method: Get FreeBusy]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Import_Appointments|Method: Import Appointments]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Tasks|Method: Get Tasks]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Item|Method: Get Item]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Briefcase|Method: Get Briefcase]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Get_Briefcase_Item|Method: Get Briefcase Item]]}} | |||
{{Template:Tab2|[[ZCS_6.0:Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}} | |||
{{Template:TabFooter}} | |||
{{Article Infobox|{{admin}}|{{ZCS 6.0}}||}}[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | {{Article Infobox|{{admin}}|{{ZCS 6.0}}||}}[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | ||
Revision as of 21:39, 14 April 2010
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