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

package

ZimbraSoapPhp

Methods

Constructor

__construct(\Zm_Auth $auth) 

Arguments

$auth

\Zm_Auth

soap authentication

createDomain

createDomain(string $name, array $attrs = array()) : array

Arguments

$name

string

a domain name

$attrs

array

an optional array containing the domain attributes to be set

Response

array

an array with the new domain's info

deleteDomain

deleteDomain(string $idOrNameDomain, string $type = "auto") : array

Arguments

$idOrNameDomain

string

domain id or domain name

$type

string

value of the domain (auto, name, id)

Response

array

informations

domainExists

domainExists(string $idOrNameDomain, string $type = "auto") : boolean

Arguments

$idOrNameDomain

string

domain id or domain name

$type

string

value of the domain (auto, name, id)

Response

boolean

exists

getAllDomains

getAllDomains() : array

Response

array

informations

getDomainId

getDomainId(string $name) : string

Arguments

$name

string

a domain name

Response

string

a domain id

getDomainOptions

getDomainOptions(string $idOrNameDomain, string $type = "auto") : array

Arguments

$idOrNameDomain

string

domain id or domain name

$type

string

value of the domain (auto, name, id)

Response

array

modifyDomain

modifyDomain(string $idOrNameDomain, array $attrs = array(), string $type = "auto") : array

Arguments

$idOrNameDomain

string

domain id or domain name

$attrs

array

an array containing the domain attributes to be set

$type

string

value of the domain (auto, name, id)

Response

array

Properties

$auth

auth : \Zm_Auth
var

soap authentication

Type(s)

\Zm_Auth