Zimbra REST API Reference:Export Mailbox

Revision as of 23:11, 3 January 2012 by CAH (talk | contribs) (Usage Examples)


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



Go to Command Format

HTTP Method



zip,tar,tgz (Go to Response Formats)

Requires Authentication

true (Go to Authentication)


  • fmt. Required. The response format.
  • query. Optional. A query string.

Usage Examples

Retrieve the entire mailbox for "john.doe" as ZIP format:


Retrieve the entire mailbox for "john.doe" as Compressed TAR format:


Retrieve the inbox content (only) for "john.doe" as ZIP format:


Retrieve the inbox content (inbox + all sub-folders) for "john.doe" as ZIP format:


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: 2012-01-03

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