Zimbra REST API Reference:Get Briefcase: Difference between revisions

(New page: << Back to Zimbra REST API Reference == REST API Method: Get Briefcase == Gets the items in the folder. === URL === <pre> http://localhost:7070/ho...)
 
No edit summary
Line 3: Line 3:
== REST API Method: Get Briefcase ==
== REST API Method: Get Briefcase ==


Gets the items in the folder.
Gets the list of items in the briefcase folder. The default folder is "Briefcase" but user-defined folders are also supported.


=== URL ===
=== URL ===
Line 14: Line 14:


<code>GET</code>
<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>
<li><code>inbox</code>. The inbox folder.</li>
<li><code>drafts</code>. The drafts folder.</li>
<li><code>sent</code>. The sent items folder.</li>
<li><code>trash</code>. The trash folder.</li>
<li><code>junk</code>. The junk/spam folder.</li>
</ul>


=== Formats ===
=== Formats ===
Line 31: Line 19:
<code>xml,json,rss,zip,tar,tgz</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Response_Formats|Go to Response Formats]])
<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).
Note: When using the <code>zip,tar,tgz</code> formats, the items in the briefcase folder are packaged in the archive.


=== Requires Authentication ===
=== Requires Authentication ===
Line 41: Line 29:
<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>
</ul>
</ul>


=== Usage Examples ===
=== Usage Examples ===


Retrieve the inbox folder in RSS format:
Retrieve the list of items in the "Briefcase" folder in JSON format:
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=rss
</pre>
 
Retrieve the inbox folder in XML format:
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=xml
</pre>
 
Retrieve the drafts folder, query for keyword "automobile", in XML format:
<pre>
http://localhost:7070/home/john.doe/drafts?fmt=xml&query=automobile
</pre>
 
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=is:unread
http://localhost:7070/home/john.doe/Briefcase?fmt=json
</pre>
</pre>


Retrieve the inbox folder, query for tag "test", in XML format:
Retrieve the list of items in the "Briefcase" folder in XML format:
<pre>
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=tag:test
http://localhost:7070/home/john.doe/Briefcase?fmt=xml
</pre>
</pre>


Retrieve the inbox folder, query for phrase "new automobile" in the message subject, in XML format:
Download all items in the "Briefcase" folder in a ZIP archive:
<pre>
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=subject:"new+automobile"
http://localhost:7070/home/john.doe/Briefcase?fmt=zip
</pre>
</pre>


Retrieve the user-defined folder "mycustomers", in JSON format:
Retrieve the user-defined folder "MyBriefcaseFolder", in JSON format:  
<pre>
<pre>
http://localhost:7070/home/john.doe/mycustomers?fmt=json
http://localhost:7070/home/john.doe/MyBriefcaseFolder?fmt=zip
</pre>
</pre>


Revision as of 22:44, 20 January 2010

<< Back to Zimbra REST API Reference

REST API Method: Get Briefcase

Gets the list of items in the briefcase folder. The default folder is "Briefcase" but user-defined folders are also supported.

URL

http://localhost:7070/home/john.doe/Briefcase?{params}

HTTP Method

GET

Formats

xml,json,rss,zip,tar,tgz (Go to Response Formats)

Note: When using the zip,tar,tgz formats, the items in the briefcase folder are packaged in the archive.

Requires Authentication

true (Go to Authentication)

Parameters

  • fmt. Required. The response format.

Usage Examples

Retrieve the list of items in the "Briefcase" folder in JSON format: 

http://localhost:7070/home/john.doe/Briefcase?fmt=json

Retrieve the list of items in the "Briefcase" folder in XML format: 

http://localhost:7070/home/john.doe/Briefcase?fmt=xml

Download all items in the "Briefcase" folder in a ZIP archive: 

http://localhost:7070/home/john.doe/Briefcase?fmt=zip

Retrieve the user-defined folder "MyBriefcaseFolder", in JSON format: 

http://localhost:7070/home/john.doe/MyBriefcaseFolder?fmt=zip


Verified Against: Zimbra Collaboration Suite 6.0 Date Created: 01/16/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Get_Briefcase Date Modified: 2010-01-20



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

Other help Resources

User Help Page »
Official Forums »
Zimbra Documentation Page »

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 »


Retrieved from "http://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Get_Briefcase&oldid=17543"
Jump to: navigation, search