Class KerioConnectApi

Administration API for Kerio Connect.

This class implements product-specific methods and properties.

Example:

<?php
require_once(dirname(__FILE__) . '/src/KerioConnectApi.php');

$api = new KerioConnectApi('Sample application', 'Company Ltd.', '1.0');

try {
    $api->login('mail.company.tld', 'admin', 'SecretPassword');
    $api->sendRequest('...');
    $api->logout();
} catch (KerioApiException $error) {
    print $error->getMessage();
}
?>

KerioApi implements KerioApiInterface

KerioConnectApi

Copyright: Copyright © 2012-2012 Kerio Technologies s.r.o.
License: http://www.kerio.com/developers/license/sdk-agreement
Version: 1.4.0.234
Located at KerioConnectApi.php

Methods summary

`public`	# `__construct( string $name, string $vendor, string $version )` Class constructor. Class constructor. Parameters `$name` `string` Application name `$vendor` `string` Application vendor `$version` `string` Application version Throws `KerioApiException` Overrides `KerioApi::__construct`
`public`	# `setComponentAdmin( )` Set component Web Administration. Set component Web Administration.
`public`	# `setComponentClient( )` Set component Client aka WebMail. Set component Client aka WebMail.
`public`	# `setComponentWebmail( )` Set component WebMail. Set component WebMail. Deprecated
`public array`	# `getConstants( )` Get constants defined by product. Get constants defined by product. Returns `array` Array of constants

Methods inherited from KerioApi

checkHttpResponse(), clean(), debug(), downloadFile(), getApiVersion(), getApplication(), getCookie(), getDebug(), getFile(), getHttpGetRequest(), getHttpPostRequest(), getHttpPutRequest(), getHttpRequest(), getJsonRpc(), getToken(), login(), logout(), send(), sendRequest(), sendRequestJson(), setCookie(), setDebug(), setHostname(), setJsonRpc(), setTimeout(), setToken(), uploadFile()

Magic methods summary

Constants summary

Constants inherited from KerioApi

CRLF, HTTP_SERVER_OK

Properties summary

`protected array`	`$jsonRpc`	# Defines default product-specific JSON-RPC settings. Defines default product-specific JSON-RPC settings.

Properties inherited from KerioApi

$application, $cookies, $headers, $hostname, $name, $token, $version

Namespaces

Classes

Interfaces

Exceptions

Class KerioConnectApi

Methods summary

Parameters

Throws

Overrides