Zimbra REST API Reference:Export Mailbox: Difference between revisions
Malte Stretz (talk | contribs) (fix "entire mailbox" example) |
Malte Stretz (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
{{Template:TabHeader}} | {{Template:TabHeader}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference|Introduction]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Folder|Method: Get Folder]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Message|Method: Import Message]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Contacts|Method: Get Contacts]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Contacts|Method: Import Contacts]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Calendar|Method: Get Calendar]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Get_FreeBusy|Method: Get FreeBusy]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Appointments|Method: Import Appointments]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Tasks|Method: Get Tasks]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Item|Method: Get Item]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase|Method: Get Briefcase]]}} | ||
{{Template:Tab2|[[ | {{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase_Item|Method: Get Briefcase Item]]}} | ||
{{Template:Tab1|[[ | {{Template:Tab1|[[Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}} | ||
{{Template:TabFooter}} | {{Template:TabFooter}} | ||
Revision as of 17:27, 5 August 2014
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 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