Public Member Functions
	__construct ($domainObj, $parentObj)
	__get ($varName)
	__set ($varName, $varValue)
	addAccount ($name, $pass)
	addAccountClass ($name)
	addAlias ($name)
	addFolderRcpt ($name)
	addGroup ($name)
	addList ($name, $pass, $adminEmail)
	compactStorage ($forced=0, $usid=null)
	configAccountDefaultFilters ()
	configAccountDefaultLimits ()
	configAccountDefaultQuotas ()
	configAccountDefaultSendRecvRestrictions ()
	configAccountDefaultWebmailAdvertising ()
	configAdminLimits ()
	configFilters ()
	configMigrationData ()
	configPublicFolder ()
	getAccountClasses ($die=Debug::INFOERROR, $filter=null)
	getDomainObj ()
	getDomainServicesObj ()
	getSessionObj ()
	listAccountClasses ($filter="")
	listAccounts ($filter="")
	listAliases ()
	listFolderRcpts ($filter="")
	listGroups ($filter="")
	listLists ($filter="")
	listStorages ()
	migrateAccount ($localAccount, $remoteHost, $remotePort, $remoteUser, $remoteUserPassword, $ignoredFolders=null, $overrideQuota=0, $deleteOriginal=0, $structureOnly=0)
	purgeAccountFolders ($folders, $condition=null)
	purgePublicFolders ($folders, $condition=null)
	registryInformation ()
	removeAccount ($name)
	removeAccountClass ($name)
	removeAlias ($name)
	removeFolderRcpt ($name)
	removeGroup ($name)
	removeList ($name)
	repairAccount ($name)
	resetLdapSynchronization ()
	save ()
	storageInformation ()
	syncContacts ()
	updateAccount ($name)
	updateAccountClass ($name)
	updateFolderRcpt ($name)
	updateGroup ($name)
	updateList ($name)
	upgradeStorage ($forced=0)

Member Function Documentation

Domain::__get ( $ varName )

Get member.

member	description
name	the domain name
assignedIp	the domain assigned IP
appenderText	the domain appender text
enableSmtpIncoming	SMTP Incoming status
enableSmtpOutgoing	SMTP Outgoing status
enablePop3	POP3 status
enableRpop	RPOP status
enableImap	IMAP status
enableWebmail	Webmail status
showWebmailLogin	displays this domain at Webmail login
publishRcptContacts	switch indicating if domain recipients contacts are published
enableAppender	the message appender
catchAllType	the type of Catch-All behavior (one of "disabled", "account" or "publicFolder")
catchAllAccountName	the name of the account used to store all messages with unknown recipient
catchAllFolderName	the name of the folder used to store all messages with unknown recipient
enableLDAPSync	enables/disables LDAP-AXIGEN synchronization
ldapSyncConnectorName	the name of the LDAP connector to use
customerReference	the customer reference for use with external billing-like systems
defaultLanguage	the default language
defaultTimeZone	the default timezone
createUsersFromLdap	enabled/disabled auto-creation of users authenticated from LDAP
disposableMetadataQuotaThreshold	the disposable meta-data quota threshold

Domain::__set	(	$	varName,
		$	varValue
	)

Set member.

member	description
name	the domain name
assignedIp	the domain assigned IP
appenderText	the domain appender text
enableSmtpIncoming	SMTP Incoming status
enableSmtpOutgoing	SMTP Outgoing status
enablePop3	POP3 status
enableRpop	RPOP status
enableImap	IMAP status
enableWebmail	Webmail status
showWebmailLogin	displays this domain at Webmail login
publishRcptContacts	switch indicating if domain recipients contacts are published
enableAppender	the message appender
catchAllType	the type of Catch-All behavior (one of "disabled", "account" or "publicFolder")
catchAllAccountName	the name of the account used to store all messages with unknown recipient
catchAllFolderName	the name of the folder used to store all messages with unknown recipient
enableLDAPSync	enables/disables LDAP-AXIGEN synchronization
ldapSyncConnectorName	the name of the LDAP connector to use
customerReference	the customer reference for use with external billing-like systems
defaultLanguage	the default language
defaultTimeZone	the default timezone
createUsersFromLdap	enabled/disabled auto-creation of users authenticated from LDAP
disposableMetadataQuotaThreshold	the disposable meta-data quota threshold

Domain::addAccount	(	$	name,
		$	pass
	)

this method adds an account to the domain

Returns:: bool

Parameters:

	$name	string this is the name for the new account
	$pass	string this is the password for the new account

Domain::addAccountClass ( $ name )

this method adds a new Account Class to the domain

Returns:: bool

Parameters:

$name

string this is the Account class name that will be added to the domain

Domain::addAlias ( $ name )

this method adds a new Alias to the domain

Returns:: bool

Parameters:

$name

string this is the Alias name that will be added to the domain

Domain::addFolderRcpt ( $ name )

this method adds a new FolderRcpt to the domain

Returns:: bool

Parameters:

$name

string this is the FolderRcpt name that will be added to the domain

Domain::addGroup ( $ name )

this method adds a new Group to the domain

Returns:: bool

Parameters:

$name

string this is the group name that will be added to the domain

Domain::addList	(	$	name,
		$	pass,
		$	adminEmail
	)

this method adds a new List to the domain

Returns:: bool

Parameters:

	$name	string this is the list name that will be added to the domain
	$pass	string this is the list password
	$adminEmail	string this is the list admin email address

Domain::configAccountDefaultFilters ( )

these filters are applied to the accounts that inherit filters from the domain Account Defaults Filters

Note:: these filters are designed for those accounts that inherit filters from the domain Account Defaults Filters

Returns:: object Filters

Domain::configAccountDefaultLimits ( )

these limits are applied to the accounts that inherit limits from the domain Account Defaults Limits

Note:: these limits are designed for those accounts that inherit limits from the domain Account Defaults Limits

Returns:: object Limits

Domain::configAccountDefaultQuotas ( )

these quotas are applied to the accounts that inherit quotas from the domain Account Defaults Quotas

Note:: these quotas are designed for those accounts that inherit quotas from the domain Account Defaults Quotas

Returns:: object Quotas

Domain::configAccountDefaultSendRecvRestrictions ( )

This function returns an object of SendRecvRestrictions type for the selected domain

Returns:: object SendRecvRestrictions

Domain::configAccountDefaultWebmailAdvertising ( )

returns the account default Webmail advertising object

Returns:: object WebmailAdvertising

Domain::configAdminLimits ( )

This function returns an object of AdminLimits type for the selected domain

Returns:: object AdminLimits

Domain::configFilters ( )

This function returns an object of Filters type for the selected domain

Returns:: object Filters

Note:: these filters apply at domain level

Domain::configMigrationData ( )

This function returns an object of MigrationData type for the selected domain

Returns:: object MigrationData

Domain::configPublicFolder ( )

This function returns an object of PublicFolder type for the selected domain

Returns:: object PublicFolder

Domain::listAccountClasses ( $ filter = "" )

this method returns an array with an Account Classes list filtered by a certain parameter

Returns:: array

Parameters:

$filter

string the AccountClasses filter (ex: accountclass*: will list all the AccountClasses that start with accountclass) (this parameter is optional)

Domain::listAccounts ( $ filter = "" )

this method returns an array with the accounts list filtered by a certain parameter

Returns:: array

Parameters:

$filter

string the account filter (ex: account*: will list all the accounts that start with account) (this parameter is optional)

Domain::listAliases ( )

this method returns an array with all the domain aliases

Returns:: array

Domain::listFolderRcpts ( $ filter = "" )

this method returns an array with a folderRcpts list filtered by a certain parameter

Returns:: array

Parameters:

$filter

string the folderRcpt filter (ex: folderRcpt*: will list all the folderRcpts that start with folderRcpt) (this parameter is optional)

Domain::listGroups ( $ filter = "" )

this method returns an array with the groups list filtered by a certain parameter

Returns:: array

Parameters:

$filter

string the group filter (ex: group*: will list all the groups that start with group) (this parameter is optional)

Domain::listLists ( $ filter = "" )

this method returns an array with a groups list filtered by a certain parameter

Returns:: array

Parameters:

$filter

string the Lists filter (ex: list*: will list all the Lists that start with list) (this parameter is optional)

Domain::listStorages ( )

lists all the storage registered on AXIGEN for this domain

Returns:: array

Domain::migrateAccount	(	$	localAccount,
		$	remoteHost,
		$	remotePort,
		$	remoteUser,
		$	remoteUserPassword,
		$	ignoredFolders = `null`,
		$	overrideQuota = `0`,
		$	deleteOriginal = `0`,
		$	structureOnly = `0`
	)

migrates an account from another server to a local account

Returns:: bool

Parameters:

	$localAccount	string the account name for migration
	$remoteHost	string the host of the migration server
	$remotePort	int the IMAP port of the migration server
	$remoteUser	string the IMAP username of the migration server
	$remoteUserPassword	string the IMAP password of the migration server
	$ignoredFolders	string/array specifies a list of folders which will not be migrated (either string for one folder, or an array for one or more) (optional parameter)
	$overrideQuota	bool specifies whether the mailbox quota should be overwritten (default: no) (optional parameter)
	$deleteOriginal	bool enables/disables the deletion of all migrated messages on the remote server (default: no) (optional parameter)
	$structureOnly	bool enables migration for the directory structure only (default: no) (optional parameter)

Domain::registryInformation ( )

this method returns an array with domain Registry Information

Returns:: array

Domain::removeAccount ( $ name )

this method removes an account from the domain

Returns:: bool

Parameters:

$name

string this is the account name that will be removed from the domain

Domain::removeAccountClass ( $ name )

this method removes an Account Class from the domain

Returns:: bool

Parameters:

$name

string this is the Account Class name that will be removed from the domain

Domain::removeAlias ( $ name )

this method removes an Alias from the domain

Returns:: bool

Parameters:

$name

string this is the Alias name that will be removed from the domain

Domain::removeFolderRcpt ( $ name )

this method removes a FolderRcpt from the domain

Returns:: bool

Parameters:

$name

string this is the folderRcpt name that will be removed from the domain

Domain::removeGroup ( $ name )

this method removes a group from the domain

Returns:: bool

Parameters:

$name

string this is the group name that will be removed from the domain

Domain::removeList ( $ name )

this method removes a List from the domain

Returns:: bool

Parameters:

$name

string this is the list name that will be removed from the domain

Domain::repairAccount ( $ name )

tries to recover lost accounts; the function will return the name of the newly-created account

Returns:: string

Parameters:

$name

string the account name that the server will try to repair

Domain::resetLdapSynchronization ( )

resets the ldap syncronization (any syncronization in progress must be stopped first)

Returns:: bool

Domain::save ( )

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

Returns:: bool

Domain::storageInformation ( )

this method returns an array with domain Storage Information

Returns:: array

Domain::syncContacts ( )

synchronizes Domain Contacts folder with domain's objects contact information

Returns:: bool

Domain::updateAccount ( $ name )

this method returns an object with the selected account loaded

Returns:: Account

Parameters:

$name

string this is the account name that will be loaded

Domain::updateAccountClass ( $ name )

this method returns an object with the selected Account Class loaded

Returns:: object AccountClass

Parameters:

$name

string this is the Account Class name that will be loaded

Domain::updateFolderRcpt ( $ name )

this method returns an object with the selected Folder Rcpt loaded

Returns:: FolderRcpt

Parameters:

$name

string this is the Folder Rcpt name that will be loaded

Domain::updateGroup ( $ name )

this method returns an object with the selected group loaded

Returns:: Group

Parameters:

$name

string this is the group name that will be loaded

Domain::updateList ( $ name )

this method returns an object with the selected MailList loaded

Returns:: MailList

Parameters:

$name

string this is the list name that will be loaded

Domain::upgradeStorage ( $ forced = 0 )

upgrades the storage representation of configuration data and folders to the latest version

Returns:: bool

Parameters:

$forced

bool forced upgrade (optional)

CLI API Documentation

Public Member Functions

Member Function Documentation