Zm_Server
Zm_Server is a class which allows to manage Kerio servers via SOAP
You may create, modify, rename, delete and get the attributes of a Kerio server using this class
For the usage examples of all class methods check the source code of test.php
Table of Contents
- $auth : Zm_Auth
- $auth
- __construct() : mixed
- Constructor
- createServer() : array<string|int, mixed>
- createServer
- deleteServer() : array<string|int, mixed>
- deleteServer
- getAllServers() : array<string|int, mixed>
- getAllServers
- getServerId() : string
- getServerId
- getServerOptions() : array<string|int, mixed>
- getServerOptions
- modifyServer() : array<string|int, mixed>
- modifyServer
- serverExists() : bool
- serverExists
Properties
$auth
$auth
private
Zm_Auth
$auth
Methods
__construct()
Constructor
public
__construct(Zm_Auth $auth) : mixed
Parameters
- $auth : Zm_Auth
-
soap authentication
Return values
mixed —createServer()
createServer
public
createServer(string $name[, array<string|int, mixed> $attrs = array() ]) : array<string|int, mixed>
Parameters
- $name : string
-
a server name
- $attrs : array<string|int, mixed> = array()
-
an optional array containing the server attributes to be set
Return values
array<string|int, mixed> —an array with the new server's info
deleteServer()
deleteServer
public
deleteServer(string $idOrNameServer[, string $type = "auto" ]) : array<string|int, mixed>
Parameters
- $idOrNameServer : string
-
server id or server name
- $type : string = "auto"
-
value of the server (auto, name, id)
Return values
array<string|int, mixed> —informations
getAllServers()
getAllServers
public
getAllServers() : array<string|int, mixed>
Return values
array<string|int, mixed> —informations
getServerId()
getServerId
public
getServerId(string $name) : string
Parameters
- $name : string
-
a server name
Return values
string —a server id
getServerOptions()
getServerOptions
public
getServerOptions(string $idOrNameServer[, string $type = "auto" ]) : array<string|int, mixed>
Parameters
- $idOrNameServer : string
-
server id or server name
- $type : string = "auto"
-
value of the server (auto, name, id)
Return values
array<string|int, mixed> —modifyServer()
modifyServer
public
modifyServer(string $idOrNameServer[, array<string|int, mixed> $attrs = array() ][, string $type = "auto" ]) : array<string|int, mixed>
Parameters
- $idOrNameServer : string
-
server id or server name
- $attrs : array<string|int, mixed> = array()
-
an array containing the server attributes to be set
- $type : string = "auto"
-
value of the server (auto, name, id)
Return values
array<string|int, mixed> —informations
serverExists()
serverExists
public
serverExists(string $idOrNameServer[, string $type = "auto" ]) : bool
Parameters
- $idOrNameServer : string
-
server id or server name
- $type : string = "auto"
-
value of the server (auto, name, id)
Return values
bool —exists