Zimbra REST API Reference:Export Mailbox

Revision as of 21:11, 14 April 2010 by Cfremon (talk | contribs) (Adding Article Infobox and category)
Admin Article

Article Information

This article applies to the following ZCS versions.

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.

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


Verified Against: Zimbra Collaboration Suite 6.0 Date Created: 01/16/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Export_Mailbox Date Modified: 2010-04-14



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