Zimbra REST API Reference:Export Mailbox: Difference between revisions
(Adding Article Infobox and category) |
No edit summary |
||
(13 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{BC|Community Sandbox}} | ||
__FORCETOC__ | |||
<div class="col-md-12 ibox-content"> | |||
=Zimbra REST API Reference - Export Mailbox= | |||
{{KB|{{Unsupported}}|{{ZCS 8.0}}|{{ZCS 7.0}}|}} | |||
{{WIP}}{{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:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase|Method: Get Briefcase]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase_Item|Method: Get Briefcase Item]]}} | |||
{{Template:Tab1|[[Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}} | |||
{{Template:TabFooter}} | |||
[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | |||
== REST API Method: Export Mailbox == | == REST API Method: Export Mailbox == | ||
Line 30: | Line 51: | ||
<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> | <li><code>query</code>. Optional. A query string.</li> | ||
<li><code>meta</code>. Optional. Use meta=1 to include meta files, meta=0 to not include meta files. If omitted, defaults to meta=1 if format is tar or tgz, and defaults to meta=0 if format is zip.</li> | |||
</ul> | </ul> | ||
=== Usage Examples === | === Usage Examples === | ||
Retrieve the | Retrieve the mailbox for "john.doe" as Compressed TAR format (the Trash and Spam folders are excluded unless the options <tt>zimbraPrefIncludeTrashInSearch</tt> and <tt>zimbraPrefIncludeSpamInSearch</tt> are enabled): | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/?fmt= | http://localhost:7070/home/john.doe/?fmt=tgz | ||
</pre> | </pre> | ||
Retrieve the entire mailbox for "john.doe" as Compressed TAR format: | Retrieve the entire mailbox for "john.doe" as Compressed TAR format: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/?fmt=tgz | http://localhost:7070/home/john.doe/?fmt=tgz&query=is:anywhere | ||
</pre> | |||
Retrieve the entire mailbox for "john.doe" as ZIP format: | |||
<pre> | |||
http://localhost:7070/home/john.doe/?fmt=zip&meta=1&query=is:anywhere | |||
</pre> | </pre> | ||
Line 51: | Line 78: | ||
Retrieve the inbox content (inbox + all sub-folders) for "john.doe" as ZIP format: | Retrieve the inbox content (inbox + all sub-folders) for "john.doe" as ZIP format: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/?fmt=zip&query=under:inbox | http://localhost:7070/home/john.doe/?fmt=zip&meta=1&query=under:inbox | ||
</pre> | </pre> | ||
{{Article Footer|Zimbra Collaboration | {{Article Footer|Zimbra Collaboration Server 7.0|01/16/2010}} | ||
[[Category:REST]] | [[Category:REST]] | ||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] | [[Category:ZCS 6.0]] | ||
[[Category:Developers]] | [[Category:Developers]] |
Latest revision as of 14:33, 13 July 2015
Zimbra REST API Reference - Export Mailbox
<< Back to Zimbra REST API Reference
REST API Method: Export Mailbox
Exports the entire contents of a mailbox.
URL
http://localhost:7070/home/john.doe/?{query-parameters}
Go to Command Format
HTTP Method
GET
Formats
zip,tar,tgz
(Go to Response Formats)
Requires Authentication
true
(Go to Authentication)
Parameters
fmt
. Required. The response format.query
. Optional. A query string.meta
. Optional. Use meta=1 to include meta files, meta=0 to not include meta files. If omitted, defaults to meta=1 if format is tar or tgz, and defaults to meta=0 if format is zip.
Usage Examples
Retrieve the mailbox for "john.doe" as Compressed TAR format (the Trash and Spam folders are excluded unless the options zimbraPrefIncludeTrashInSearch and zimbraPrefIncludeSpamInSearch are enabled):
http://localhost:7070/home/john.doe/?fmt=tgz
Retrieve the entire mailbox for "john.doe" as Compressed TAR format:
http://localhost:7070/home/john.doe/?fmt=tgz&query=is:anywhere
Retrieve the entire mailbox for "john.doe" as ZIP format:
http://localhost:7070/home/john.doe/?fmt=zip&meta=1&query=is:anywhere
Retrieve the inbox content (only) for "john.doe" as ZIP format:
http://localhost:7070/home/john.doe/?fmt=zip&query=in:inbox
Retrieve the inbox content (inbox + all sub-folders) for "john.doe" as ZIP format:
http://localhost:7070/home/john.doe/?fmt=zip&meta=1&query=under:inbox