Zimbra REST API Reference:Get Folder: Difference between revisions
Malte Stretz (talk | contribs) (Remove old ZCS_6.0 prefixes) |
|||
(26 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
[[ | {{Template:TabHeader}} | ||
{{Template:Tab2|[[Zimbra_REST_API_Reference|Introduction]]}} | |||
{{Template:Tab1|[[Zimbra_REST_API_Reference:Get_Folder|Method: Get Folder]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Message|Method: Import Message]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Contacts|Method: Get Contacts]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Contacts|Method: Import Contacts]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Calendar|Method: Get Calendar]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_FreeBusy|Method: Get FreeBusy]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Appointments|Method: Import Appointments]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Tasks|Method: Get Tasks]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Item|Method: Get Item]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase|Method: Get Briefcase]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase_Item|Method: Get Briefcase Item]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}} | |||
{{Template:TabFooter}} | |||
{{Article Infobox|{{devel}}|{{ZCS 8.0}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}}[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | |||
== REST API Method: Get Folder == | == REST API Method: Get Folder == | ||
Line 12: | Line 27: | ||
</pre> | </pre> | ||
Go to [[ZCS_6.0:Zimbra_REST_API_Reference#Command_Format|Command Format]] | |||
=== HTTP Method === | |||
<code>GET</code> | |||
=== Folder Name === | |||
<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 22: | Line 43: | ||
<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> | ||
</ul> | </ul> | ||
=== Formats === | === Formats === | ||
<code>xml,json,rss,tar,tgz | <code>xml,json,rss,zip,tar,tgz</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Response_Formats|Go to Response Formats]]) | ||
Note: When using the <code>zip,tar,tgz</code> formats, the mail messages are packaged in the archive as <code>.eml</code> files (i.e. plain text in MIME format). | |||
=== Requires Authentication === | === Requires Authentication === | ||
<code>true</code> | <code>true</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Authentication|Go to Authentication]]) | ||
=== Parameters === | === Parameters === | ||
Line 41: | Line 59: | ||
<ul> | <ul> | ||
<li><code>fmt</code>. Required. The response format.</li> | <li><code>fmt</code>. Required. The response format.</li> | ||
<li><code>query</code>. Optional. A query string | <li><code>query</code>. Optional. A query string.</li> | ||
</ul> | </ul> | ||
Line 61: | Line 79: | ||
</pre> | </pre> | ||
Retrieve the inbox folder, query for | Retrieve the inbox folder, query for "automobile" in the message subject, in XML format: | ||
<pre> | |||
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=subject:automobile | |||
</pre> | |||
Retrieve the inbox folder, query for "unread" messages, in XML format: | |||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/inbox?fmt=xml&query= | http://localhost:7070/home/john.doe/inbox?fmt=xml&query=is:unread | ||
</pre> | </pre> | ||
Retrieve the inbox folder, query for | Retrieve the inbox folder, query for tag "test", in XML format: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/inbox?fmt=xml&query= | http://localhost:7070/home/john.doe/inbox?fmt=xml&query=tag:test | ||
</pre> | </pre> | ||
Retrieve the | Retrieve the inbox folder, query for phrase "new automobile" in the message subject, in XML format: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/ | http://localhost:7070/home/john.doe/inbox?fmt=xml&query=subject:"new+automobile" | ||
</pre> | </pre> | ||
Retrieve the user-defined folder "mycustomers", in JSON format: | |||
<pre> | |||
http://localhost:7070/home/john.doe/mycustomers?fmt=json | |||
</pre> | |||
{{Article Footer|Zimbra Collaboration Server 7.0|01/16/2010}} | |||
[[Category:REST]] | |||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] | |||
[[Category:Developers]] |
Latest revision as of 17:20, 5 August 2014
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