Zimbra REST API Reference:Export Mailbox: Difference between revisions
m (→Parameters: added usage of meta option to include or not include meta files with tar or tgz or zip format) |
|||
Line 63: | Line 63: | ||
Retrieve the inbox content (only) for "john.doe" as ZIP format: | Retrieve the inbox content (only) for "john.doe" as ZIP format: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/?fmt=zip | http://localhost:7070/home/john.doe/?fmt=zip&query=in:inbox | ||
</pre> | </pre> | ||
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> | ||
Revision as of 23:23, 3 January 2012
Article Information |
---|
This article applies to the following ZCS versions. |
<< 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. If format is tar or tgz, use meta=1 to include meta files, meta=0 to not include meta files. If omitted, defaults to meta=1. If the format is zip, use meta=1 to include meta files, meta=0 to not include meta files. If omitted, defaults to meta=0.
Usage Examples
Retrieve the entire mailbox for "john.doe" as ZIP format:
http://localhost:7070/home/john.doe/?fmt=zip
Retrieve the entire mailbox for "john.doe" as Compressed TAR format:
http://localhost:7070/home/john.doe/?fmt=tgz
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