Zimbra REST API Reference:Export Mailbox: Difference between revisions
(→URL) |
|||
| Line 34: | Line 34: | ||
=== Usage Examples === | === Usage Examples === | ||
Retrieve the entire mailbox for "john.doe" as | Retrieve the entire mailbox for "john.doe" as ZIP format: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/?fmt=zip | http://localhost:7070/home/john.doe/?fmt=zip | ||
</pre> | </pre> | ||
Retrieve the entire mailbox for "john.doe" as | 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 | ||
</pre> | |||
Retrieve the inbox content (only) for "john.doe" as ZIP format: | |||
<pre> | |||
http://localhost:7070/home/john.doe/?fmt=zip&query=in:inbox | |||
</pre> | |||
Retrieve the inbox content (inbox + all sub-folders) for "john.doe" as ZIP format: | |||
<pre> | |||
http://localhost:7070/home/john.doe/?fmt=zip&query=under:inbox | |||
</pre> | </pre> | ||
Revision as of 04:03, 11 February 2010
<< 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.
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&query=under:inbox
