Zm_Domain
Zm_Domain is a class which allows to manage Zimbra domains via SOAP
You may create, modify, rename, delete and get the attributes of a Zimbra domain 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
- createDomain() : array<string|int, mixed>
- createDomain
- deleteDomain() : array<string|int, mixed>
- deleteDomain
- domainExists() : bool
- domainExists
- getAllDomains() : array<string|int, mixed>
- getAllDomains
- getDomainId() : string
- getDomainId
- getDomainOptions() : array<string|int, mixed>
- getDomainOptions
- modifyDomain() : array<string|int, mixed>
- modifyDomain
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 —createDomain()
createDomain
public
createDomain(string $name[, array<string|int, mixed> $attrs = array() ]) : array<string|int, mixed>
Parameters
- $name : string
-
a domain name
- $attrs : array<string|int, mixed> = array()
-
an optional array containing the domain attributes to be set
Return values
array<string|int, mixed> —an array with the new domain's info
deleteDomain()
deleteDomain
public
deleteDomain(string $idOrNameDomain[, string $type = "auto" ]) : array<string|int, mixed>
Parameters
- $idOrNameDomain : string
-
domain id or domain name
- $type : string = "auto"
-
value of the domain (auto, name, id)
Return values
array<string|int, mixed> —informations
domainExists()
domainExists
public
domainExists(string $idOrNameDomain[, string $type = "auto" ]) : bool
Parameters
- $idOrNameDomain : string
-
domain id or domain name
- $type : string = "auto"
-
value of the domain (auto, name, id)
Return values
bool —exists
getAllDomains()
getAllDomains
public
getAllDomains() : array<string|int, mixed>
Return values
array<string|int, mixed> —informations
getDomainId()
getDomainId
public
getDomainId(string $name) : string
Parameters
- $name : string
-
a domain name
Return values
string —a domain id
getDomainOptions()
getDomainOptions
public
getDomainOptions(string $idOrNameDomain[, string $type = "auto" ]) : array<string|int, mixed>
Parameters
- $idOrNameDomain : string
-
domain id or domain name
- $type : string = "auto"
-
value of the domain (auto, name, id)
Return values
array<string|int, mixed> —modifyDomain()
modifyDomain
public
modifyDomain(string $idOrNameDomain[, array<string|int, mixed> $attrs = array() ][, string $type = "auto" ]) : array<string|int, mixed>
Parameters
- $idOrNameDomain : string
-
domain id or domain name
- $attrs : array<string|int, mixed> = array()
-
an array containing the domain attributes to be set
- $type : string = "auto"
-
value of the domain (auto, name, id)