jlaso/zimbra-soap-api-bundle

Bundle to communicate with Zimbra ZCS servers through soap api

dev-master 2018-11-14 20:24 UTC

Requires

• php: >=5.3.2
• symfony/validator: *

GPL-3.0-only

• Joseluis Laso
• Chris Ramakers
• Libersoft

• zimbra
• zcs

README

This Bundle is based in the work of Chris Ramakers, see original repo on https://github.com/nucleus-be/Zimbra

Usage

add to require area in composer.json
```
    "jlaso/zimbra-soap-api-bundle" : "*"
``

add in AppKernel.php

```
    public function registerBundles()
    {
        $bundles = array(
            //...
            new \Jlaso\ZimbraSoapApiBundle\ZimbraSoapApiBundle(),
            //...
        );


        return $bundles;
    }
```

add to parameters.yml

```
    jlaso_zimbra_soap_api:
        server: localhost
        port: 7071
        username: admin
        password: "adminpassword"
        debug: true
```

A generic exception that indicates something went wrong in the Zimbra library, specifics on the error are contained in the exception message, most of the times this is a 1-on-1 copy of the error the SoapClient received as Fault message/code from the Zimbra Soap API.

This exception is only ever thrown with the error code 1000

\Zimbra\ZCS\Exception\InvalidEntity

This exception is thrown when the library tries to construct an Entity but fails to do so because of failed validation. What exactly is wrong can be retrieved by calling $exception->getErrors() which returns an associative array of all failed validation rules.

This exception is only ever thrown with the error code 1100

\Zimbra\ZCS\Exception\EntityNotFound

This exception is thrown when an entity is requested but cannot be found on the ZCS server. There are several possible error codes, each code translates to what exactly is missing.

• 1201 domain cannot be found
• 1202 account cannot be found
• 1203 alias cannot be found
• 1204 cos cannot be found