Zimbra REST API Reference

https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference
Admin
Zimbra REST API Reference provides comprehensive documentation for accessing and managing Zimbra...
Tokens:17,707
Snippets:167
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Get FreeBusy usage examples

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_FreeBusy

Three equivalent URLs to export free/busy data for all calendars configured to be included in free/busy data.

```http
http://localhost:7070/home/john.doe/calendar.ifb
```

```http
http://localhost:7070/home/john.doe/calendar?fmt=ifb
```

```http
http://localhost:7070/home/john.doe/?fmt=ifb
```

--------------------------------

### Get mail message with sync metadata inline

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Example using fmt=sync to return metadata in response headers and inline.

```http
http://localhost:7070/home/john.doe/?id=288&fmt=sync

```

--------------------------------

### GET /home/{user}/{folder-name}

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Folder

Gets the items in the specified folder. The response format is determined by the 'fmt' parameter, and an optional query can filter the results.

```APIDOC
## GET /home/{user}/{folder-name}

### Description
Gets the items in the folder.

### Method
GET

### Endpoint
http://localhost:7070/home/{user}/{folder-name}

### Parameters
#### Path Parameters
- **user** (string) - Required - The user's mailbox identifier (e.g., john.doe).
- **folder-name** (string) - Required - The name of the mail folder to access. Can be a default folder (inbox, drafts, sent, trash, junk) or a user-defined folder.

#### Query Parameters
- **fmt** (string) - Required - The response format. Supported values: xml, json, rss, zip, tar, tgz.
- **query** (string) - Optional - A query string to filter the items in the folder.

### Request Example
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=subject:automobile

### Response
#### Success Response (200)
The response contains the items in the folder in the requested format. For zip, tar, and tgz formats, the mail messages are packaged as .eml files.

#### Response Example
(No explicit response example provided in the source.)

```

--------------------------------

### Download a specific item by ID

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Example to download an item using the id query parameter.

```http
http://localhost:7070/home/john.doe/?id=657

```

--------------------------------

### Retrieve user-defined folder 'mycustomers' in JSON format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Folder

Example URL to retrieve the user-defined folder 'mycustomers' in JSON format.

```http
http://localhost:7070/home/john.doe/mycustomers?fmt=json

```

--------------------------------

### Import Appointments with curl

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AImport_Appointments

Example using curl to upload an ICS file to import appointments. Replace {username} and {password} with the account credentials.

```bash
curl --user {username}:{password} --upload-file /tmp/myappointments.ics http://localhost:7070/home/john.doe/calendar?fmt=ics
```

--------------------------------

### Retrieve inbox for current authenticated user

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Example using the '~' shortcut for the current authenticated user.

```http
http://localhost:7070/home/~/inbox.rss

```

--------------------------------

### GET /home/{user}/{folder}?auth=qp&zauthtoken={token}

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Retrieve a folder using query parameter authentication. The authentication token is passed in the `zauthtoken` request parameter.

```APIDOC
## GET /home/{user}/{folder}?auth=qp&zauthtoken={token}

### Description
Retrieve a folder using query parameter authentication. The authentication token is passed in the `zauthtoken` request parameter.

### Method
GET

### Endpoint
/home/{user}/{folder}?auth=qp&zauthtoken={token}

### Parameters
#### Query Parameters
- **auth** (string) - Required - Set to `qp` to use query parameter authentication.
- **zauthtoken** (string) - Required - The authentication token.

### Request Example
```
http://localhost:7070/home/john.doe/inbox.rss?auth=qp&zauthtoken=0_thisismyzauthtokenthisismyzauthtoken_thisismyzauthtoken
```

### Response
#### Success Response (200)
- **body** (content) - The requested folder content in the requested format (e.g., RSS).

#### Response Example
```
(Content of the folder in the requested format)
```
```

--------------------------------

### GET /home/{user}/{folder}?auth=sc

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Retrieve a folder using Basic Authentication and set a cookie after authentication.

```APIDOC
## GET /home/{user}/{folder}?auth=sc

### Description
Retrieve a folder using Basic Authentication and set a cookie after authentication.

### Method
GET

### Endpoint
/home/{user}/{folder}?auth=sc

### Parameters
#### Query Parameters
- **auth** (string) - Required - Set to `sc` to use Basic Authentication and set a cookie after authentication.

### Request Example
```
http://localhost:7070/home/john.doe/inbox.rss?auth=sc
```

### Response
#### Success Response (200)
- **body** (content) - The requested folder content in the requested format (e.g., RSS).

#### Response Example
```
(Content of the folder in the requested format)
```
```

--------------------------------

### Get FreeBusy with time range

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_FreeBusy

Exports free/busy data for the next 60 days using the start and end parameters with relative dates.

```http
http://localhost:7070/home/john.doe/calendar.ifb?start=0d&end=60d
```

--------------------------------

### Get Item URL format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Item

Base URL pattern for the Get Item method. Replace {item-id} with the item ID and {params} with optional parameters such as fmt.

```http
http://localhost:7070/home/john.doe/?id={item-id}&{params}

```

--------------------------------

### Get Folder URL format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Folder

Base URL pattern for the Get Folder method. Replace {folder-name} with the folder name and {params} with query parameters.

```http
http://localhost:7070/home/john.doe/{folder-name}?{params}

```

--------------------------------

### Get mail message with sync metadata in headers only

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Example using fmt=sync&nohdr=1 to return metadata only in response headers.

```http
http://localhost:7070/home/john.doe/?id=288&fmt=sync&nohdr=1

```

--------------------------------

### Retrieve inbox folder in XML format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Folder

Example URL to retrieve the inbox folder in XML format.

```http
http://localhost:7070/home/john.doe/inbox?fmt=xml

```

--------------------------------

### Retrieve inbox for user john.doe@mydomain.com

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Example using the explicit user format with domain.

```http
http://localhost:7070/home/john.doe@mydomain.com/inbox.rss

```

--------------------------------

### GET /home/{user}/{folder}

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase

Retrieves the list of items in the briefcase folder. The default folder is 'Briefcase' but user-defined folders are also supported. The response format can be specified using the fmt parameter.

```APIDOC
## GET /home/{user}/{folder}

### Description
Gets the list of items in the briefcase folder. The default folder is "Briefcase" but user-defined folders are also supported.

### Method
GET

### Endpoint
http://localhost:7070/home/john.doe/Briefcase?{params}

### Parameters
#### Query Parameters
- **fmt** (string) - Required - The response format. Supported formats: xml, json, rss, zip, tar, tgz.

### Request Example
http://localhost:7070/home/john.doe/Briefcase?fmt=json

### Response
#### Success Response (200)
- The response contains the list of items in the briefcase folder. The format depends on the fmt parameter.

#### Response Example
(No explicit response example provided in the source.)

```

--------------------------------

### Retrieve inbox folder with query for tag 'test'

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Folder

Example URL to retrieve the inbox folder, querying for tag 'test', in XML format.

```http
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=tag:test

```

--------------------------------

### Export inbox content with zmmailbox GET

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Use the zmmailbox CLI with the getRestURL command to perform GET methods, such as exporting the inbox content in ZIP format. The -t 0 option sets the timeout to infinity, which is important for large mailboxes.

```bash
zmmailbox -z -m user@domain.com -t 0 getRestURL "/inbox?fmt=zip"
```

--------------------------------

### Retrieve drafts folder with query for keyword 'automobile'

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Folder

Example URL to retrieve the drafts folder, querying for the keyword 'automobile', in XML format.

```http
http://localhost:7070/home/john.doe/drafts?fmt=xml&query=automobile

```

--------------------------------

### Get Briefcase - XML format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase

Retrieves the list of items in the 'Briefcase' folder in XML format using the fmt=xml parameter.

```http
http://localhost:7070/home/john.doe/Briefcase?fmt=xml
```

--------------------------------

### Get Briefcase URL template

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase

The base URL pattern for the Get Briefcase method. Replace 'john.doe' with the user's email and 'Briefcase' with the folder name. The {params} placeholder represents optional query parameters.

```http
http://localhost:7070/home/john.doe/Briefcase?{params}
```

--------------------------------

### Get Calendar in XML Format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Calendar

Retrieve the calendar in XML format.

```http
http://localhost:7070/home/john.doe/calendar?fmt=xml
```

--------------------------------

### Get Briefcase - JSON format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase

Retrieves the list of items in the 'Briefcase' folder in JSON format using the fmt=json parameter.

```http
http://localhost:7070/home/john.doe/Briefcase?fmt=json
```

--------------------------------

### GET /home/{user}/{folder}?auth=co

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Retrieve a folder using cookie-based authentication. The authentication token is taken from the ZM_AUTH_TOKEN cookie.

```APIDOC
## GET /home/{user}/{folder}?auth=co

### Description
Retrieve a folder using cookie-based authentication. The authentication token is taken from the ZM_AUTH_TOKEN cookie.

### Method
GET

### Endpoint
/home/{user}/{folder}?auth=co

### Parameters
#### Query Parameters
- **auth** (string) - Required - Set to `co` to use cookie authentication.

### Request Example
```
http://localhost:7070/home/john.doe/inbox.rss?auth=co
```

### Response
#### Success Response (200)
- **body** (content) - The requested folder content in the requested format (e.g., RSS).

#### Response Example
```
(Content of the folder in the requested format)
```
```

--------------------------------

### GET /home/{user}/{folder}?auth=nsc

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Retrieve a folder using Basic Authentication without setting a cookie (same as `ba`).

```APIDOC
## GET /home/{user}/{folder}?auth=nsc

### Description
Retrieve a folder using Basic Authentication without setting a cookie (same as `ba`).

### Method
GET

### Endpoint
/home/{user}/{folder}?auth=nsc

### Parameters
#### Query Parameters
- **auth** (string) - Required - Set to `nsc` to use Basic Authentication without setting a cookie.

### Request Example
```
http://localhost:7070/home/john.doe/inbox.rss?auth=nsc
```

### Response
#### Success Response (200)
- **body** (content) - The requested folder content in the requested format (e.g., RSS).

#### Response Example
```
(Content of the folder in the requested format)
```
```

--------------------------------

### Get Briefcase Item URL formats

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase_Item

Two URL formats for the Get Briefcase Item REST API method. The first uses query parameters (e.g., id) and the second uses a file name in the URL path. Both require authentication and use the HTTP GET method.

```http
http://localhost:7070/home/john.doe/Briefcase?{params}
```

```http
http://localhost:7070/home/john.doe/Briefcase/{file-name}
```

--------------------------------

### Get Tasks URL template

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Tasks

Base URL pattern for the Get Tasks method. Replace john.doe with the user's mailbox name and optionally append query parameters.

```http
http://localhost:7070/home/john.doe/tasks?{params}
```

--------------------------------

### GET /home/{user}/{folder}?auth=ba

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Retrieve a folder using Basic Authentication without setting a cookie after authentication.

```APIDOC
## GET /home/{user}/{folder}?auth=ba

### Description
Retrieve a folder using Basic Authentication without setting a cookie after authentication.

### Method
GET

### Endpoint
/home/{user}/{folder}?auth=ba

### Parameters
#### Query Parameters
- **auth** (string) - Required - Set to `ba` to use Basic Authentication without setting a cookie.

### Request Example
```
http://localhost:7070/home/john.doe/inbox.rss?auth=ba
```

### Response
#### Success Response (200)
- **body** (content) - The requested folder content in the requested format (e.g., RSS).

#### Response Example
```
(Content of the folder in the requested format)
```
```

--------------------------------

### Get Contacts URL format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Contacts

Base URL pattern for the Get Contacts method. Replace 'john.doe' with the user's email and 'contacts' with the folder name. Parameters are appended after the question mark.

```http
http://localhost:7070/home/john.doe/contacts?{params}
```

--------------------------------

### Retrieve inbox for user john.doe

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Example using the explicit user format 'john.doe'.

```http
http://localhost:7070/home/john.doe/inbox.rss

```

--------------------------------

### Get Briefcase - default folder

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase

Retrieves a directory listing of the default 'Briefcase' folder, including sub-folders and documents.

```http
http://localhost:7070/home/john.doe/Briefcase
```

--------------------------------

### GET /home/{user}/{folder}/{file-name}

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase_Item

Retrieves a specified item from the briefcase folder using the file name in the URL. The default folder is 'Briefcase' but user-defined folders are also supported. Requires authentication.

```APIDOC
## GET /home/{user}/{folder}/{file-name}

### Description
Gets a specified item from the briefcase folder using the file name in the URL. The default folder is "Briefcase" but user-defined folders are also supported.

### Method
GET

### Endpoint
`http://localhost:7070/home/{user}/{folder}/{file-name}`

### Parameters
#### Path Parameters
- **user** (string) - Required - The user's account name (e.g., john.doe).
- **folder** (string) - Required - The folder name (default is "Briefcase" but user-defined folders are supported).
- **file-name** (string) - Required - The name of the file to retrieve.

### Usage Example
Retrieve the "mysalespres.ppt" item from the "Briefcase" folder:
```
http://localhost:7070/home/john.doe/Briefcase/mysalespres.ppt
```

Retrieve the "process.xls" from the user-defined folder "SupportDocuments":
```
http://localhost:7070/home/john.doe/SupportDocuments/process.xls
```

### Requires Authentication
true
```

--------------------------------

### Get Briefcase - RSS format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase

Retrieves the list of items in the 'Briefcase' folder in RSS format using the fmt=rss parameter.

```http
http://localhost:7070/home/john.doe/Briefcase?fmt=rss
```

--------------------------------

### GET /home/{account}

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AExport_Mailbox

Exports the entire contents of a mailbox. The response format is specified by the fmt parameter, and optional query and meta parameters control the export scope and inclusion of meta files.

```APIDOC
## GET /home/{account}

### Description
Exports the entire contents of a mailbox. The response format is specified by the fmt parameter, and optional query and meta parameters control the export scope and inclusion of meta files.

### Method
GET

### Endpoint
http://localhost:7070/home/{account}/?{query-parameters}

### Parameters
#### Path Parameters
- **account** (string) - Required - The mailbox account identifier (e.g., john.doe).

#### Query Parameters
- **fmt** (string) - Required - The response format. Supported values: zip, tar, tgz.
- **query** (string) - Optional - A query string to filter the exported items.
- **meta** (integer) - 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.

### Request Example
http://localhost:7070/home/john.doe/?fmt=tgz

### Response
#### Success Response (200)
- **body** (binary) - The exported mailbox content in the requested format.

#### Response Example
Binary data (zip, tar, or tgz file).

```

--------------------------------

### Get Briefcase - user-defined folder

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase

Retrieves the user-defined briefcase folder 'MyBriefcaseFolder' in JSON format.

```http
http://localhost:7070/home/john.doe/MyBriefcaseFolder?fmt=json
```

--------------------------------

### Get Calendar in JSON Format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Calendar

Retrieve the calendar in JSON format.

```http
http://localhost:7070/home/john.doe/calendar?fmt=json
```

--------------------------------

### Retrieve inbox folder in RSS format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Folder

Example URL to retrieve the inbox folder in RSS format.

```http
http://localhost:7070/home/john.doe/inbox?fmt=rss

```

--------------------------------

### Get Briefcase - ZIP archive

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase

Downloads all items in the 'Briefcase' folder as a ZIP archive using the fmt=zip parameter.

```http
http://localhost:7070/home/john.doe/Briefcase?fmt=zip
```

--------------------------------

### Get Briefcase - sub-folder

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase

Retrieves the directory of a user-defined 'TestFolder1' folder that is a sub-folder of 'Briefcase'.

```http
http://localhost:7070/home/john.doe/Briefcase/TestFolder1
```

--------------------------------

### GET /home/{user}/{folder}?id={id}

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase_Item

Retrieves a specified item from the briefcase folder using the item ID as a query parameter. The default folder is 'Briefcase' but user-defined folders are also supported. Requires authentication.

```APIDOC
## GET /home/{user}/{folder}?id={id}

### Description
Gets a specified item from the briefcase folder using the item ID as a query parameter. The default folder is "Briefcase" but user-defined folders are also supported.

### Method
GET

### Endpoint
`http://localhost:7070/home/{user}/{folder}?id={id}`

### Parameters
#### Path Parameters
- **user** (string) - Required - The user's account name (e.g., john.doe).
- **folder** (string) - Required - The folder name (default is "Briefcase" but user-defined folders are supported).

#### Query Parameters
- **id** (string) - Required - The item id.

### Usage Example
Retrieve the item (with id=149) from the "Briefcase" folder:
```
http://localhost:7070/home/john.doe/Briefcase?id=149
```

### Requires Authentication
true
```

--------------------------------

### Retrieve inbox as RSS feed

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Example REST command to retrieve all inbox items as an RSS feed.

```http
http://localhost:7070/home/user1/inbox.rss

```

--------------------------------

### Get Calendar HTML WorkWeek View

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Calendar

Retrieve the calendar HTML "workWeek" view.

```http
http://localhost:7070/home/john.doe/calendar?fmt=html&view=workWeek
```

--------------------------------

### Get Calendar HTML Month View

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Calendar

Retrieve the calendar HTML "month" view. The first URL uses the .html extension, the second uses the fmt=html parameter.

```http
http://localhost:7070/home/john.doe/calendar.html
```

```http
http://localhost:7070/home/john.doe/calendar?fmt=html
```

--------------------------------

### GET /home/{user}/{object}

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Retrieves items from a user's mailbox, such as folders, messages, contacts, calendar, tasks, or briefcase items. The object can be a folder name or omitted with query parameters to specify an item.

```APIDOC
## GET /home/{user}/{object}

### Description
Retrieves items from a user's mailbox, such as folders, messages, contacts, calendar, tasks, or briefcase items. The object can be a folder name or omitted with query parameters to specify an item.

### Method
GET

### Endpoint
{protocol}://{host}:{port}/home/{user}/{object}?{params}

### Parameters
#### Path Parameters
- **user** (string) - Required - The user account. Can be specified as username, email address, or "~" for the current authenticated user.
- **object** (string) - Optional - The folder name (e.g., inbox) or omitted to specify an item by ID.

#### Query Parameters
- **id** (string) - Optional - The item ID to retrieve when object is omitted.
- **fmt** (string) - Optional - Response format. Supported formats include xml, json, rss, atom, html, zip, tar, tgz, ics, ifb, csv, sync.
- **csvfmt** (string) - Optional - Specific CSV format when fmt=csv. Supported: zimbra-csv, yahoo-csv, thunderbird-csv, outlook-2000-csv, outlook-2003-csv.
- **nohdr** (integer) - Optional - When fmt=sync, set to 1 to return meta-data headers only, not inline.

### Request Example
```
http://localhost:7070/home/john.doe/inbox.rss
```

### Response
#### Success Response (200)
Returns the requested data in the specified format.

#### Response Example
```
RSS feed content
```

```

--------------------------------

### Retrieve inbox folder with query for unread messages

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Folder

Example URL to retrieve the inbox folder, querying for 'unread' messages, in XML format.

```http
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=is:unread

```

--------------------------------

### GET /home/{user}/tasks

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Tasks

Retrieves the tasks for a specified user. Supports multiple response formats including ICS, JSON, XML, RSS, and Atom. Authentication is required.

```APIDOC
## GET /home/{user}/tasks

### Description
Gets the tasks for the specified user.

### Method
GET

### Endpoint
http://localhost:7070/home/john.doe/tasks

### Parameters
#### Path Parameters
- **user** (string) - Required - The user whose tasks are being retrieved. In the example, this is 'john.doe'.

#### Query Parameters
- **fmt** (string) - Optional - The response format. Defaults to `ics`. Supported values: `ics`, `json`, `xml`, `rss`, `atom`.
- **query** (string) - Optional - A query string to filter tasks.

### Request Example
```
http://localhost:7070/home/john.doe/tasks?fmt=json
```

### Response
#### Success Response (200)
- The response body format depends on the `fmt` parameter. For `ics`, the response is an iCalendar file. For `xml`, it is XML. For `json`, it is JSON.

#### Response Example
No explicit response example is provided in the source.

```

--------------------------------

### GET /home/{user}?id={item-id}&{params}

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Item

Retrieves a single item (mail message, appointment, contact, or task) from the user's mailbox. The item is identified by its id, and the response format can be specified using the fmt parameter. Authentication is required.

```APIDOC
## GET /home/{user}?id={item-id}&{params}

### Description
Gets an item (mail message, appointment, contact, or task) from the user's mailbox.

### Method
GET

### Endpoint
http://localhost:7070/home/{user}?id={item-id}&{params}

### Parameters
#### Path Parameters
- **user** (string) - Required - The user's mailbox identifier (e.g., john.doe).

#### Query Parameters
- **id** (string) - Required - The item id to retrieve.
- **fmt** (string) - Optional - The response format. Supported formats depend on the item type (see Formats table).
- **imap_id** (string) - Optional - Specify an IMAP id in lieu of a message id (for mail messages only).
- **part** (string) - Optional - Specify which part of the MIME message to retrieve (for mail messages only).

### Formats
| Type | Formats | Default Format | Comments |
|------|---------|----------------|----------|
| Mail Message | json, xml, rss, atom, zip, tar, tgz, sync | MIME (RFC822) | When using zip, tar, tgz formats, the mail message is packaged in the archive as a .eml file (plain text in MIME RFC822 format). |
| Appointment | json, xml, ics | iCalendar (.ics) | |
| Contact | json, xml, vcf | vCard (.vcf) | |
| Task | json, xml, ics, rss, atom | iCalendar (.ics) | |

### Authentication
Requires authentication: true

### Usage Examples
Retrieve the mail message (with id 288) as MIME RFC822 format:
```
http://localhost:7070/home/john.doe/?id=288
```

Download the mail message (with id 553) attachment (in part 2 of the message):
```
http://localhost:7070/home/john.doe/?id=288&part=2
```

Retrieve the contact (with id 272) in XML format:
```
http://localhost:7070/home/john.doe/?id=272&fmt=xml
```

Retrieve the appointment (with id 506) in ICS format:
```
http://localhost:7070/home/john.doe/?id=506
```

Retrieve the task (with id 582) in ICS format:
```
http://localhost:7070/home/john.doe/?id=582
```

```

--------------------------------

### Retrieve inbox folder with query for 'automobile' in subject

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Folder

Example URL to retrieve the inbox folder, querying for 'automobile' in the message subject, in XML format.

```http
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=subject:automobile

```

--------------------------------

### Retrieve inbox folder with query for phrase 'new automobile' in subject

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Folder

Example URL to retrieve the inbox folder, querying for the phrase 'new automobile' in the message subject, in XML format.

```http
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=subject:"new+automobile"

```

--------------------------------

### Get Calendar from User-Defined Folder in JSON

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Calendar

Retrieve the calendar from the user-defined folder "MyHolidays" in JSON format. Note the folder name is lowercased in the URL.

```http
http://localhost:7070/home/john.doe/myholidays?fmt=json
```

--------------------------------

### Get FreeBusy URL template

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_FreeBusy

Base URL for the Get FreeBusy method. Replace john.doe with the target mailbox and include optional parameters.

```http
http://localhost:7070/home/john.doe/calendar.ifb?{params}
```

--------------------------------

### Retrieve briefcase item by file name

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase_Item

Retrieves the 'mysalespres.ppt' item from the default 'Briefcase' folder using the file name in the URL.

```http
http://localhost:7070/home/john.doe/Briefcase/mysalespres.ppt
```

--------------------------------

### Authenticate with query parameter auth token (auth=qp)

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Use the auth=qp parameter to authenticate using the zauthtoken request parameter. This is the second method checked by default.

```http
http://localhost:7070/home/john.doe/inbox.rss?auth=qp&zauthtoken=0_thisismyzauthtokenthisismyzauthtoken_thisismyzauthtoken
```

--------------------------------

### Import inbox content with zmmailbox POST

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Use the zmmailbox CLI with the postRestURL command to perform POST methods, such as importing the content of inbox.zip. The -t 0 option sets the timeout to infinity, which is important for large mailboxes.

```bash
zmmailbox -z -m user@domain.com -t 0 postRestURL "/inbox?fmt=zip" /tmp/inbox.zip
```

--------------------------------

### Retrieve tasks in XML format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Tasks

URL to retrieve tasks in XML format by setting the fmt parameter to xml.

```http
http://localhost:7070/home/john.doe/tasks?fmt=xml
```

--------------------------------

### POST /home/{username}/{folder-name}

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AImport_Message

Imports a message to a mail folder in MIME RFC822 format. Supports default and user-defined folders.

```APIDOC
## POST /home/{username}/{folder-name}

### Description
Imports a message to a mail folder in MIME RFC822 format. Default (inbox/sent/trash/junk) and user-defined folders are supported.

### Method
POST

### Endpoint
http://localhost:7070/home/{username}/{folder-name}

### Parameters
#### Path Parameters
- **username** (string) - Required - The account username (e.g., john.doe).
- **folder-name** (string) - Required - The name of the mail folder. Can be a default folder (inbox, drafts, sent, trash, junk) or a user-defined folder.

### Request Example
```
curl -u {username}:{password} --upload-file /tmp/mymessage.msg http://localhost:7070/home/john.doe/inbox
```

### Response
No response body is documented.
```

--------------------------------

### zmmailbox getRestURL

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Use the zmmailbox CLI to perform GET methods on the REST API, such as exporting mailbox content.

```APIDOC
## zmmailbox getRestURL

### Description
Use the zmmailbox CLI to perform GET methods on the REST API, such as exporting mailbox content.

### Method
GET

### Endpoint
zmmailbox -z -m user@domain.com -t 0 getRestURL "/inbox?fmt=zip"

### Parameters
#### Command Line Options
- **-z** (flag) - Required - Use Zimbra authentication.
- **-m** (string) - Required - The mailbox user (e.g., user@domain.com).
- **-t** (integer) - Optional - Timeout in seconds; set to 0 for infinity.
- **getRestURL** (string) - Required - The REST URL to GET, including query parameters.

### Request Example
```
zmmailbox -z -m user@domain.com -t 0 getRestURL "/inbox?fmt=zip"
```

### Response
#### Success Response (200)
- **body** (content) - The requested data (e.g., ZIP file content).

#### Response Example
```
(ZIP file content)
```
```

--------------------------------

### Import Appointments URL

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AImport_Appointments

The URL for importing appointments into a user's calendar. Replace john.doe with the actual username and include the required parameters.

```text
http://localhost:7070/home/john.doe/calendar?{params}
```

--------------------------------

### Authenticate with cookie auth token (auth=co)

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference

Use the auth=co parameter to authenticate using the ZM_AUTH_TOKEN cookie. This is the first method checked by default.

```http
http://localhost:7070/home/john.doe/inbox.rss?auth=co
```

--------------------------------

### Download contacts as ZIP file

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Contacts

Downloads contacts as a ZIP file by setting fmt=zip. The ZIP format includes contacts as individual vCard .vcf files.

```http
http://localhost:7070/home/john.doe/contacts?fmt=zip
```

--------------------------------

### Import Contacts from VCF with curl

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AImport_Contacts

Imports contacts from a VCF file using curl. Replace {username} and {password} with the account credentials. The fmt parameter must be set to vcf.

```bash
curl -{username}:{password} --upload-file /tmp/mycontact.vcf http://localhost:7070/home/john.doe/contacts?fmt=vcf
```

--------------------------------

### Import Message into user-defined folder with curl

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AImport_Message

Uses curl with --upload-file to post a message file to a user-defined folder named 'mymessages'. Replace {username} and {password} with account credentials.

```bash
curl -u {username}:{password} --upload-file /tmp/mymessage.msg http://localhost:7070/home/john.doe/mymessages
```

--------------------------------

### Import Contacts into MyBusinessContacts Folder

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AImport_Contacts

Imports contacts from a CSV file into the user-defined folder "Contacts > MyBusinessContacts" using curl. Replace {username} and {password} with the account credentials.

```bash
curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/contacts/mybusinesscontacts?fmt=csv
```

--------------------------------

### Retrieve tasks in JSON format

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Tasks

URL to retrieve tasks in JSON format by setting the fmt parameter to json.

```http
http://localhost:7070/home/john.doe/tasks?fmt=json
```

--------------------------------

### Import Message into inbox folder with curl

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AImport_Message

Uses curl with --upload-file to post a message file to the inbox folder. Replace {username} and {password} with account credentials.

```bash
curl -u {username}:{password} --upload-file /tmp/mymessage.msg http://localhost:7070/home/john.doe/inbox
```

--------------------------------

### GET /home/{user}/calendar.ifb

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_FreeBusy

Retrieves free/busy data for the specified user's calendars that are configured to be included in free/busy data. The response format is iCalendar (ifb) by default.

```APIDOC
## GET /home/{user}/calendar.ifb

### Description
Retrieves free/busy data for the specified user's calendars that are configured to be included in free/busy data. The response format is iCalendar (ifb) by default.

### Method
GET

### Endpoint
http://localhost:7070/home/{user}/calendar.ifb?{params}

### Parameters
#### Query Parameters
- **fmt** (string) - Optional - The response format. Defaults to `ifb`.
- **start** (string) - Optional - The start time range. Can be specified in milliseconds, yyyy/dd/mm, mm/dd/yyy, or relative dates.
- **end** (string) - Optional - The end time range. Can be specified in milliseconds, yyyy/dd/mm, mm/dd/yyy, or relative dates.

### Relative Dates
Relative dates are either in the future (p/+/{not-specified}) or the past (m/-), along with a numeric value, followed by the units. For units, everything after the first character is ignored (except for the "mi" case):
- m(onths)
- mi(nutes)
- d(ays)
- w(eeks)
- h(ours)
- y(ears)

Examples:
- `start=1day` is "1 day from now"
- `end=+2days` is "2 days from now"
- `start=p1day` is "1 day from now"
- `end=-2days` is "2 days ago"
- `start=+60mi` is "60 minutes from now"
- `end=+1week` is "1 week from now"
- `end=+6mon` is "6 months from now"
- `start=1year` is "1 year from now"

### Usage Examples
Export free/busy data for all calendars that are configured to be included in free/busy data:
```
http://localhost:7070/home/john.doe/calendar.ifb
```
```
http://localhost:7070/home/john.doe/calendar?fmt=ifb
```
```
http://localhost:7070/home/john.doe/?fmt=ifb
```

Export free/busy data for all calendars that are configured to be included in free/busy data for the next 60 days:
```
http://localhost:7070/home/john.doe/calendar.ifb?start=0d&end=60d
```

### Authentication
Requires authentication: true

### Formats
- ifb
```

--------------------------------

### Download contacts as CSV (default format)

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Contacts

Retrieves contacts in CSV format. The first URL uses the default format (csv) without specifying fmt; the second explicitly sets fmt=csv.

```http
http://localhost:7070/home/john.doe/contacts
```

```http
http://localhost:7070/home/john.doe/contacts?fmt=csv
```

--------------------------------

### Get Calendar HTML Day View for Specific Date

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Calendar

Retrieve the calendar HTML "day" view on January 23, 2009 (01/23/2009). The date parameter uses the format yyyymmdd.

```http
http://localhost:7070/home/john.doe/calendar?fmt=html&view=day&date=20090123
```

--------------------------------

### Retrieve briefcase item from user-defined folder

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Briefcase_Item

Retrieves the 'process.xls' item from the user-defined folder 'SupportDocuments' using the file name in the URL.

```http
http://localhost:7070/home/john.doe/SupportDocuments/process.xls
```

--------------------------------

### Download tasks as iCalendar (ICS)

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Tasks

Two equivalent URLs to download tasks in ICS format. The first uses the default format (ics), the second explicitly requests fmt=ics.

```http
http://localhost:7070/home/john.doe/tasks
```

```http
http://localhost:7070/home/john.doe/tasks?fmt=ics
```

--------------------------------

### GET /home/{username}/contacts

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Contacts

Retrieves contacts from the designated folder. The default folder is 'contacts' but user-defined folders are also supported. Supports multiple response formats including CSV, JSON, XML, and ZIP.

```APIDOC
## GET /home/{username}/contacts

### Description
Gets the contacts in the designated folder. The default folder is "contacts" but user-defined folders are also supported.

### Method
GET

### Endpoint
http://localhost:7070/home/{username}/contacts

### Parameters
#### Path Parameters
- **username** (string) - Required - The user's account name (e.g., john.doe).

#### Query Parameters
- **fmt** (string) - Optional - The response format. Defaults to `csv`. Supported formats: `csv`, `json`, `xml`, `tgz`, `zip`.
- **csvfmt** (string) - Optional - If format is `csv`, optionally select the CSV type. Supported values: `zimbra-csv`, `yahoo-csv`, `thunderbird-csv`, `outlook-2000-csv`, `outlook-2003-csv`.
- **meta** (integer) - Optional - If format is `tar` or `tgz`, optionally include meta files. Use `meta=1` to include, `meta=0` to exclude. Defaults to `meta=1`.
- **query** (string) - Optional - A query string to filter contacts.

### Request Example
No request body required. Example URL:
```
http://localhost:7070/home/john.doe/contacts?fmt=json&query=martha
```

### Response
#### Success Response (200)
The response format depends on the `fmt` parameter. For `csv`, returns CSV data. For `json`, returns JSON data. For `xml`, returns XML data. For `zip`, returns a ZIP file containing individual vCard `.vcf` files.

#### Response Example
For JSON format:
```json
{
  "contacts": [
    {
      "id": "contact-id",
      "firstName": "John",
      "lastName": "Doe"
    }
  ]
}
```

### Authentication
Requires authentication: `true`
```

--------------------------------

### GET /home/{user}/calendar

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AGet_Calendar

Retrieves calendar appointments from the specified user's calendar folder. Supports multiple response formats and optional parameters for time range, query, and HTML view customization.

```APIDOC
## GET /home/{user}/calendar

### Description
Gets the appointments from the calendar. The default folder is "calendar" but user-defined folders are also supported.

### Method
GET

### Endpoint
http://localhost:7070/home/{user}/calendar?{params}

### Parameters
#### Path Parameters
- **user** (string) - Required - The user whose calendar is being accessed.

#### Query Parameters
- **fmt** (string) - Optional - The response format. Defaults to `ics`. Supported formats: `ics`, `json`, `xml`, `rss`, `atom`, `html`.
- **start** (string) - Optional - The start time range. Can be milliseconds, `yyyy/dd/mm`, `mm/dd/yyy`, or relative dates.
- **end** (string) - Optional - The end time range. Can be milliseconds, `yyyy/dd/mm`, `mm/dd/yyy`, or relative dates.
- **query** (string) - Optional - A query string.

#### HTML Format Parameters
- **view** (string) - Optional - Designates the display when using the `html` format. Options: `day`, `week`, `workWeek`, `month`.
- **date** (string) - Optional - Designates the date to display when using the `html` format. Format is `yyyymmdd`. For example, 2/15/2010 is `date=20100215`.
- **notoolbar** (integer) - Optional - Specifies to not include the toolbar (`notoolbar=1`).
- **color** (integer) - Optional - The color of the appointment text. Options: 0=defaultColor, 1=blue, 2=cyan, 3=green, 4=purple, 5=red, 6=yellow, 7=pink, 8=gray, 9=orange.

### Relative Dates
Relative dates are either in the future (p/+/{not-specified}) or the past (m/-), along with a numeric value, followed by the units. For units, everything after the first character is ignored (except for the "mi" case):
- m(onths)
- mi(nutes)
- d(ays)
- w(eeks)
- h(ours)
- y(ears)

Examples:
- `start=1day` is "1 day from now"
- `end=+2days` is "2 days from now"
- `start=p1day` is "1 day from now"
- `end=-2days` is "2 days ago"
- `start=+60mi` is "60 minutes from now"
- `end=+1week` is "1 week from now"
- `end=+6mon` is "6 months from now"
- `start=1year` is "1 year from now"

### Usage Examples
Download the calendar as an iCalendar (ICS) file:
```
http://localhost:7070/home/john.doe/calendar
```
```
http://localhost:7070/home/john.doe/calendar?fmt=ics
```

Retrieve the calendar in XML format:
```
http://localhost:7070/home/john.doe/calendar?fmt=xml
```

Retrieve the calendar from the user-defined folder "MyHolidays" in JSON format:
```
http://localhost:7070/home/john.doe/myholidays?fmt=json
```

Retrieve the calendar in JSON format:
```
http://localhost:7070/home/john.doe/calendar?fmt=json
```

Retrieve the calendar HTML "month" view:
```
http://localhost:7070/home/john.doe/calendar.html
```
```
http://localhost:7070/home/john.doe/calendar?fmt=html
```

Retrieve the calendar HTML "workWeek" view:
```
http://localhost:7070/home/john.doe/calendar?fmt=html&view=workWeek
```

Retrieve the calendar HTML "day" view on January 23, 2009 (01/23/2009):
```
http://localhost:7070/home/john.doe/calendar?fmt=html&view=day&date=20090123
```

### Response
#### Success Response (200)
The response format depends on the `fmt` parameter. For `ics`, the response is an iCalendar file. For `json`, `xml`, `rss`, `atom`, the response is in the corresponding format. For `html`, the response is an HTML page.

#### Response Example
No example response is provided in the source documentation.

```

--------------------------------

### Import Contacts into SalesContacts Folder

Source: https://wiki.zimbra.com/wiki/Zimbra_REST_API_Reference%3AImport_Contacts

Imports contacts from a CSV file into the user-defined folder "SalesContacts" using curl. Replace {username} and {password} with the account credentials.

```bash
curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/salescontacts?fmt=csv
```
Tokens:
Raw