nucleus-be / zimbra-api
PHP wrapper library around the Zimbra Soap API (web service)
Requires
- php: >=5.4.0
- evenement/evenement: ~2.0
- guzzlehttp/guzzle: ^6.1
- phpcollection/phpcollection: 0.*
Suggests
- ext-soap: *
This package is not auto-updated.
Last update: 2023-06-24 11:56:19 UTC
README
This API is a simple Object Oriented wrapper for the zimbra soap api (web service). It's written with PHP 5.4. It allows you to manage zimbra accounts, zimbra domains and zimbra servers easily.
Requirement
- PHP >= 5.4.x with cURL extension,
- Guzzle 6/psr7 library,
- Evenement library,
- PhpCollection library,
- (optional) PHPUnit to run tests,
- (optional) Soap extension for WSDL client and run tests.
Autoload
The new version of zimbra-api
using Composer.
The first step to use zimbra-api
is to download composer:
$ curl -s http://getcomposer.org/installer | php
Then we have to install our dependencies using:
$ php composer.phar install
Now we can use autoloader from Composer by:
{ "require": { "nucleus-b/zimbra-api": "^1.0" } }
zimbra-api
follows the PSR-0 convention names for its classes, which means you can easily integratezimbra-api
classes loading in your own autoloader.
Basic usage of zimbra-api
admin client
<?php // This file is generated by Composer require_once 'vendor/autoload.php'; $api = \Zimbra\Admin\AdminFactory::instance('https://localhost:7071/service/admin/soap'); $authToken = $api->auth('username', 'password'); $api->auth('username', 'password'); $account = new \Zimbra\Struct\AccountSelector(\Zimbra\Enum\AccountBy::NAME(), 'username'); $accountInfo = $api->getAccountInfo($account);
From $api
object, you can access to all zimbra admin api.
##Licensing BSD 3-Clause
For the full copyright and license information, please view the LICENSE
file that was distributed with this source code.