From Zimbra :: Wiki

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

Article Information
This article applies to the following ZCS versions.
ZCS 7.0
ZCS 6.0

<< Back to Zimbra REST API Reference

Contents 1 REST API Method: Export Mailbox 1.1 URL 1.2 HTTP Method 1.3 Formats 1.4 Requires Authentication 1.5 Parameters 1.6 Usage Examples

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 entire mailbox for "john.doe" as ZIP format:

http://localhost:7070/home/john.doe/?fmt=zip&meta=1

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&meta=1&query=under:inbox

Verified Against: Zimbra Collaboration Server 7.0	Date Created: 01/16/2010
Article ID: http://wiki.zimbra.com/index.php?title=ZCS_6.0:Zimbra_REST_API_Reference:Export_Mailbox	Date Modified: 1/3/2012