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
 
(12 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:Tab2|[[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:Tab1|[[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 7.0}}|{{ZCS 6.0}}|}}[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]]


== 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 10: Line 26:
http://localhost:7070/home/john.doe/Briefcase?{params}
http://localhost:7070/home/john.doe/Briefcase?{params}
</pre>
</pre>
Go to [[ZCS_6.0:Zimbra_REST_API_Reference#Command_Format|Command Format]]


=== HTTP Method ===
=== HTTP Method ===


<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 37:
<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 47:
<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 a directory of the "Briefcase" folder (this will include a list of sub-folders and documents):
<pre>
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=rss
http://localhost:7070/home/john.doe/Briefcase
</pre>
</pre>


Retrieve the inbox folder in XML format:
Retrieve the list of items in the "Briefcase" folder in JSON format:
<pre>
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=xml
http://localhost:7070/home/john.doe/Briefcase?fmt=json
</pre>
</pre>


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


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


Retrieve the inbox folder, query for "unread" messages, 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=is:unread
http://localhost:7070/home/john.doe/Briefcase?fmt=zip
</pre>
</pre>


Retrieve the inbox folder, query for tag "test", in XML format:
Retrieve the user-defined briefcase folder "MyBriefcaseFolder", in JSON format:  
<pre>
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=tag:test
http://localhost:7070/home/john.doe/MyBriefcaseFolder?fmt=json
</pre>
</pre>


Retrieve the inbox folder, query for phrase "new automobile" in the message subject, in XML format:
Retrieve the directory of a user-defined "TestFolder1" folder that is a sub-folder of "Briefcase":
<pre>
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=subject:"new+automobile"
http://localhost:7070/home/john.doe/Briefcase/TestFolder1
</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}}




{{Article Footer|Zimbra Collaboration Suite 6.0|01/16/2010}}
[[Category:REST]]
[[Category:ZCS 7.0]]
[[Category:ZCS 6.0]]
[[Category:Developers]]

Latest revision as of 17:26, 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 7.0 Article ZCS 7.0 ZCS 6.0 Article ZCS 6.0

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

Go to Command Format

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 a directory of the "Briefcase" folder (this will include a list of sub-folders and documents):

http://localhost:7070/home/john.doe/Briefcase

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

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

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

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

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

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

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

Retrieve the directory of a user-defined "TestFolder1" folder that is a sub-folder of "Briefcase":

http://localhost:7070/home/john.doe/Briefcase/TestFolder1


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