sc = Use Basic Authentication and set cookie after authentication.ba = Use Basic Authentication and do not set cookie after authentication.These methods refer to Basic Authentication: The authentication token will be retrieved from request parameter zauthtoken. The authentication token will be retrieved from the ZM_AUTH_TOKEN cookie. The auth= parameter supports a list of comma-separated values which include: Meaning: first, check for a cookie auth token second, check for query parameter auth token thrid, prompt for basic authentication. Using the auth= parameter, you can designate how to authenticate and whether or not to set the authentication cookie.ĭefault is auth=co,nsc,qp.

There are multiple methods to authenticate as a user when accessing a mailbox. The following is a list of the meta-data headers: For example, get a mail message by item id and return the meta-data in the response headers only. When using this option, the headers are returned inline of the response, unless you specify nohdr=1.įor example, get a mail message by item id and return the meta-data in the response headers and inline. Requests that the server return additional meta-data in the response headers. A specific CSV format can be designated using the csvfmt parameter. See and RFC 2445.Ĭommon Separated Values file format. Really Simple Syndication web feed format. See the specific command for a list of supported formats and command-specific details:Įxtensible Markup Language file format. The following describes the various response formats, designated using the fmt= parameter. See the specific command for a list of the required and optional parameters. If omitted, the query parameters provide the information the command requires.įor example, to download the inbox folder as XML:Ī list of command-specific URL parameters. This might be a folder (such as inbox or drafts) or omitted (to download a specific item). For example:ĭesignates the object to perform the command against.

can also use '~' as a shortcut to the current authenticated user.

To load an explicit user account, specify the user in one of the following formats: The host name or IP address of the Zimbra Collaboration Suite server The transport protocol, for example, http. The following describes the components of the Zimbra REST command: HTTP POST methods are for creating/modifying items. Learn more about REST at the Wikipedia article Representational State Transfer. For example, the following REST command retrieves all inbox items as a simple RSS feed: REST (REpresentational State Transfer) is an approach for building application services that make resources available via a URL. This document is the reference for that functionality.

This article applies to the following ZCS versions.

Zimbra soap api