Zimbra REST API: Briefcase Methods | Zimbra

In this article we are going to analyze the Briefcase methods of the Zimbra REST API. For an overview and in-depth coverage about it, we refer you to the related article in our technical blog.

Get Briefcase

This method gets the list of items in briefcase folde. The HTTP method to read data is get. The default folder used is clearly “Briefcase”, but you can choose a custom one by the user.

The basic url is:

http(s)://<host>/home/sample.user/Briefcase?{params}

Formats

You can choose between various formats, such as xml, json, rss, zip, tar, tgz.

Please note that if you are going to use archive formats (zip,tar,tgz), then the items in the briefcase folder are packaged in the archive

Parameters

The response format fmt parameter is required.

Examples

If you want to retrieve a directory, with a list of sub-folders and documents of the Briefcase folder, you can type:

https://mail.sampledomain.com/home/james.red/Briefcase

If you want to retrieve the directory of a user-defined “CustomFolder” folder that is a sub-folder of “Mybriefcase”:

https://mail.sampledomain.com/home/james.red/Mybriefcase/CustomFolder

Get Briefcase Item

This method gets a specified item from the briefcase folder. The HTTP method to read data is get. The default folder used is clearly “Briefcase”, but you can choose a custom one by the user.

The basic url is:

http(s)://<host>/home/sample.user/Briefcase?{params}

or

http(s)://<host>/home/sample.user/Briefcase?{file-name}

Parameters

The item id parameter is required. You can use, as an alternative, the file name in the URL.

Examples

If you want to retrieve the item with id=789 from the “Briefcase” folder:

https://mail.sampledomain.com/home/james.red/Briefcase?id=789

If you want to retrieve the file “presentation.ppt” from the user-defined folder “BusinessPresentations”:

https://mail.sampledomain.com/home/james.red/BusinessPresentations/presentation.ppt