List of all members.

Public Member Functions
	__construct ($serverObj, $parentObj)
	__get ($name)
	__set ($name, $value)
	addUsermap ($name, $type= 'local', $userdbConnectorType=null, $userdbConnectorName=null, $localFile=null)
	configCli ()
	configDnr ()
	configFilters ()
	configFtpBackup ()
	configImap ()
	configImapProxy ()
	configLog ()
	configMobility ()
	configPop3 ()
	configPop3Proxy ()
	configProcessing ()
	configReport ()
	configRpop ()
	configSmtpIn ()
	configSmtpOut ()
	configUserDb ()
	configWebadmin ()
	configWebmail ()
	configWebmailProxy ()
	getEnableIOSync ()
	getPrimaryDomain ()
	getServerObj ()
	getServicesObj ()
	getSessionObj ()
	getSslRandomFile ()
	listUsermaps ()
	removeUsermap ($name)
	save ()
	services ()
	setEnableIOSync ($enable)
	setPrimaryDomain ($name)
	setSslRandomFile ($file)
	startService ($serviceName)
	stopService ($serviceName)
	updateUsermap ($name)

---

Member Function Documentation

Server::__get

(

$

name

)

Get member.

member	description
primaryDomain	the name of the Axigen primary domain
sslRandomFile	the path to the SSL random file
defaultLanguage	the default language
defaultTimeZone	the default timezone
serverName	the server name
enableIOSynchronization	the enabled/disabled status for I/O Synchronization
enableProcessing	the enabled/disabled status for Processing
enableSmtpIncoming	the enabled/disabled status for SMTP Incoming
enableSmtpOutgoing	the enabled/disabled status for SMTP Outgoing
enablePop3	the enabled/disabled status for POP3
enablePop3Proxy	the enabled/disabled status for Pop3 Proxy
enableRpop	the enabled/disabled status for RPOP
enableImap	the enabled/disabled status for IMAP
enableImapProxy	the enabled/disabled status for IMAP Proxy
enableWebmail	the enabled/disabled status for Webmail
enableWebmailProxy	the enabled/disabled status for Webmail Proxy
enableCli	the enabled/disabled status for CLI
enableLog	the enabled/disabled status for Log
enableReporting	the enabled/disabled status for Reporting
enableFtpBackup	the enabled/disabled status for Ftp Backup
maxIndexingThreads	the maximum number of threads for the search indexing service

Server::__set	(	$	name,
		$	value
	)

Set member.

member	description
primaryDomain	the name of the Axigen primary domain
sslRandomFile	the path to the SSL random file
defaultLanguage	the default language
defaultTimeZone	the default timezone
serverName	the server name
enableIOSynchronization	the enabled/disabled status for I/O Synchronization
enableProcessing	the enabled/disabled status for Processing
enableSmtpIncoming	the enabled/disabled status for SMTP Incoming
enableSmtpOutgoing	the enabled/disabled status for SMTP Outgoing
enablePop3	the enabled/disabled status for POP3
enablePop3Proxy	the enabled/disabled status for Pop3 Proxy
enableRpop	the enabled/disabled status for RPOP
enableImap	the enabled/disabled status for IMAP
enableImapProxy	the enabled/disabled status for IMAP Proxy
enableWebmail	the enabled/disabled status for Webmail
enableWebmailProxy	the enabled/disabled status for Webmail Proxy
enableCli	the enabled/disabled status for CLI
enableLog	the enabled/disabled status for Log
enableReporting	the enabled/disabled status for Reporting
enableFtpBackup	the enabled/disabled status for Ftp Backup
maxIndexingThreads	the maximum number of threads for the search indexing service

Server::addUsermap	(	$	name,
		$	type = 'local',
		$	userdbConnectorType = null,
		$	userdbConnectorName = null,
		$	localFile = null
	)

This method is used at adding a usermap

Parameters:

	$name	string name of a usermap
	$type	string type of a usermap
	$userdbConnectorType	string userdb connector type
	$userdbConnectorName	string userdb connector name
	$localFile	string usermap local file

Returns:

bool

Server::configCli

(

)

this method returns an object of CLI for the selected server

Returns:

object Cli

Server::configDnr

(

)

this method returns an object of DNR for the selected server

Returns:

object Dnr

Server::configFilters

(

)

this method returns an object of Filters for the selected server

Returns:

object Filters

Server::configFtpBackup

(

)

this method returns an object of FtpBackup for the selected server

Returns:

object FtpBackup

Server::configImap

(

)

this method returns an object of IMAP for the selected server

Returns:

object Imap

Server::configImapProxy

(

)

this method returns an object of ImapProxy for the selected server

Returns:

object ImapProxy

Server::configLog

(

)

this method returns an object of Log for the selected server

Returns:

object Log

Server::configMobility

(

)

this method returns an object of Mobility for the selected server

Returns:

object Mobility

Server::configPop3

(

)

this method returns an object of POP3 for the selected server

Returns:

object Pop3

Server::configPop3Proxy

(

)

this method returns an object of Pop3Proxy for the selected server

Returns:

object Pop3Proxy

Server::configProcessing

(

)

this method returns an object of Processing for the selected server

Returns:

object Processing

Server::configReport

(

)

this method returns an object of Report for the selected server

Returns:

object Report

Server::configRpop

(

)

this method returns an object of RPOP for the selected server

Returns:

object Rpop

Server::configSmtpIn

(

)

this method returns an object of SmtpIn for the selected server

Returns:

object SmtpIn

Server::configSmtpOut

(

)

this method returns an object of SmtpOut for the selected server

Returns:

object SmtpOut

Server::configUserDb

(

)

this method returns an object of UserDb for the selected server

Returns:

object UserDb

Server::configWebadmin

(

)

this method returns an object of Webadmin for the selected server

Returns:

object Webadmin

Server::configWebmail

(

)

this method returns an object of Webmail for the selected server

Returns:

object Webmail

Server::configWebmailProxy

(

)

this method returns an object of WebmailProxy for the selected server

Returns:

object WebmailProxy

Server::listUsermaps

(

)

this method returns an array with the usermaps list

Returns:

array

Server::removeUsermap

(

$

name

)

This method removes a usermap by name

Parameters:

$name

string the name of the usermap that is removed

Returns:

bool

Server::save

(

)

This function saves a server object back to Axigen

Returns:

bool

Server::services

(

)

returns an array with all the services and their status

Returns:

array

Server::startService

(

$

serviceName

)

starts an Axigen service

Returns:

bool

Parameters:

$serviceName

string the name of the service that you want to start

Server::stopService

(

$

serviceName

)

stops an Axigen service

Returns:

bool

Parameters:

$serviceName

string the name of the service that you want to stop

Server::updateUsermap

(

$

name

)

This method returns an object of usermap type

Parameters:

$name

string the name of the usermap that will be loaded

Returns:

object Usermap