CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($domainRegistrationObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  addMessagesLocation ($path)
  getDomainRegistrationObj ()
  getSessionObj ()
  listMessageStorageLocation ()
  removeMessagesLocation ($path)
  save ()

Public Attributes

  $domaintype

Member Function Documentation

DomainRegistration::__get ( varName  ) 

Get member.

member

description

name

domain name (available only on domain creation)

domainLocation

the domain storage location

domainObjectsLocation

the domain objects (eg: accounts, mail lists etc.) storage location

maclSupport

enable/disable MACL support for this domain (deprecated)

groupwareSupport

enable/disable groupware support for this domain

prefix

sub-domain name (prefix for the domain) (available only on sub-domain creation)

parentDomain

the parent domain for this sub-domain (available only on sub-domain creation)

DomainRegistration::__set ( varName,
varValue  
)

Set member.

member

description

name

domain name (available only on domain creation)

domainLocation

the domain storage location

domainObjectsLocation

the domain objects (eg: accounts, mail lists etc.) storage location

maclSupport

enable/disable MACL support for this domain (deprecated)

groupwareSupport

enable/disable groupware support for this domain

prefix

sub-domain name (prefix for the domain) (available only on sub-domain creation)

parentDomain

the parent domain for this sub-domain (available only on sub-domain creation)

DomainRegistration::addMessagesLocation ( path  ) 

adds a messages storage location

Returns:
bool
Parameters:
$path  string the path to the messages storage
DomainRegistration::listMessageStorageLocation (  ) 

lists the domain messages storage location

Returns:
array
DomainRegistration::removeMessagesLocation ( path  ) 

removes a messages storage location

Returns:
bool
Parameters:
$path  string the path to the messages storage
DomainRegistration::save (  ) 

this method must be called if one of the members has been changed

Returns:
bool