Zimbra REST API Reference:Get Folder: Difference between revisions

No edit summary
(Remove old ZCS_6.0 prefixes)
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]]
{{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 10: Line 26:
http://localhost:7070/home/john.doe/{folder-name}?{params}
http://localhost:7070/home/john.doe/{folder-name}?{params}
</pre>
</pre>
Go to [[ZCS_6.0:Zimbra_REST_API_Reference#Command_Format|Command Format]]


=== HTTP Method ===
=== HTTP Method ===
Line 17: Line 35:
=== Folder Name ===
=== Folder Name ===


<code>{folder-name}</code>. The name of the mail folder to access. Must be specified and possible values include:
<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 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 or keywords.</li>
<li><code>query</code>. Optional. A query string.</li>
</ul>
</ul>


Line 61: Line 79:
</pre>
</pre>


Retrieve the inbox folder, query for keywords "automobile" and "highway", in XML format:
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=automobile+highway
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=is:unread
</pre>
</pre>


Retrieve the inbox folder, query for phrase "new automobile", in XML format:
Retrieve the inbox folder, query for tag "test", in XML format:
<pre>
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=xml&query="new+automobile"
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=tag:test
</pre>
</pre>


Retrieve the mycustomers folder, in JSON format:
Retrieve the inbox folder, query for phrase "new automobile" in the message subject, in XML format:
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=subject:"new+automobile"
</pre>
 
Retrieve the user-defined folder "mycustomers", in JSON format:
<pre>
<pre>
http://localhost:7070/home/john.doe/mycustomers?fmt=json
http://localhost:7070/home/john.doe/mycustomers?fmt=json
Line 78: Line 106:




{{Article Footer|Zimbra Collaboration Suite 6.0|01/16/2010}}
{{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

Introduction  


Method: Get Folder  


Method: Import Message  


Method: Get Contacts  


Method: Import Contacts  


Method: Get Calendar  


Method: Get FreeBusy  


Method: Import Appointments  


Method: Get Tasks  


Method: Get Item  


Method: Get Briefcase  


Method: Get Briefcase Item  


Method: Export Mailbox  


 


Developer Article

Article Information

This article applies to the following ZCS versions.

ZCS 8.0 Article ZCS 8.0 ZCS 7.0 Article ZCS 7.0 ZCS 6.0 Article ZCS 6.0

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


Verified Against: Zimbra Collaboration Server 7.0 Date Created: 01/16/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Get_Folder Date Modified: 2014-08-05



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