Difference between revisions of "Zimbra REST API Reference:Export Mailbox"

(Parameters)
Line 46: Line 46:
 
<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. 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.</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>
  

Revision as of 16:29, 20 January 2015

Introduction  


Method: Get Folder  


Method: Import Message  


Method: Get Contacts  


Method: Import Contacts  


Method: Get Calendar  


Method: Get FreeBusy  


Method: Import Appointments  


Method: Get Tasks  


Method: Get Item  


Method: Get Briefcase  


Method: Get Briefcase Item  


Method: Export Mailbox  


 


Developer Article

Article Information

This article applies to the following ZCS versions.

ZCS 8.0 Article ZCS 8.0 ZCS 7.0 Article ZCS 7.0 ZCS 6.0 Article ZCS 6.0

<< 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


Verified Against: Zimbra Collaboration Server 7.0 Date Created: 01/16/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Export_Mailbox Date Modified: 2015-01-20



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search