Zimbra REST API Reference:Export Mailbox: Difference between revisions
No edit summary |
No edit summary |
||
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}} | {{WIP}}{{Template:TabHeader}} | ||
{{Template:Tab2|[[Zimbra_REST_API_Reference|Introduction]]}} | {{Template:Tab2|[[Zimbra_REST_API_Reference|Introduction]]}} | ||
Line 14: | Line 20: | ||
{{Template:Tab1|[[Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}} | {{Template:Tab1|[[Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}} | ||
{{Template:TabFooter}} | {{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 == |
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