public
|
#
__construct( CApiGlobalManager & $oManager, $sForcedStorage = '' )
Parameters
- $oManager
- $oManager
- $sForcedStorage
|
public
CDomain
|
|
public
CDomain
|
#
getDomainById( string $sDomainId )
Retrieve information on domain based on its ID.
Retrieve information on domain based on its ID.
Parameters
- $sDomainId
- ID of the domain to look up.
Returns
|
public
CDomain
|
#
getDomainByName( string $sDomainName )
Retrieve information on domain based on its name.
Retrieve information on domain based on its name.
Parameters
- $sDomainName
- name of the domain to look up.
Returns
|
public
CDomain
|
#
getDomainByUrl( string $sDomainUrl )
Retrieve information on domain based on Web domain value.
Retrieve information on domain based on Web domain value.
Parameters
- $sDomainUrl
- Web domain value.
Returns
|
public
boolean
|
#
createDomain( CDomain & $oDomain )
Create domain.
Parameters
- $oDomain
- $oDomain Object instance with its properties filled.
Returns
boolean
|
public
boolean
|
#
updateDomain( CDomain $oDomain )
Save domain details back to the database upon modifying the object.
Save domain details back to the database upon modifying the object.
Parameters
Returns
boolean
|
public
boolean
|
#
areDomainsEmpty( array $aDomainsIds )
Determine if listed domains can be deleted. For that, they must not hold any user accounts.
Determine if listed domains can be deleted. For that, they must not hold any user accounts.
Parameters
- $aDomainsIds
- List of domains to check.
Returns
boolean
|
public
boolean
|
#
enableOrDisableDomains( array $aDomainsIds, boolean $bEnable = true )
Enable or disable listed domains.
Enable or disable listed domains.
Parameters
- $aDomainsIds
- List of domains to enable/disable.
- $bEnable
- Default value is true. Mode switch, true for enabling domains, false for disabling.
Returns
boolean
|
public
boolean
|
#
enableOrDisableDomainsByTenantId( integer $iTenantId, boolean $bEnable = true )
Parameters
- $iTenantId
- $bEnable
- Default value is true.
Returns
boolean
|
public
boolean
|
#
deleteDomainById( integer $iDomainId, boolean $bRemoveAllAccounts = false )
Delete domain from the database. For this to work, the domain should not hold any user accounts. Domain ID is used for lookup.
Delete domain from the database. For this to work, the domain should not hold any user accounts. Domain ID is used for lookup.
Parameters
- $iDomainId
- $bRemoveAllAccounts
- Default value is false.
Returns
boolean
|
public
boolean
|
#
deleteDomains( array $aDomainsIds, boolean $bRemoveAllAccounts = false )
Delete one or several domains from the database. they must not hold any user accounts.
Delete one or several domains from the database. they must not hold any user accounts.
Parameters
- $aDomainsIds
- $bRemoveAllAccounts
- Default value is false.
Returns
boolean
|
public
boolean
|
#
deleteDomainsByTenantId( integer $iTenantId, boolean $bRemoveAllAccounts = false )
Parameters
- $iTenantId
- $bRemoveAllAccounts
- Default value is false.
Returns
boolean
|
public
boolean
|
#
deleteDomainByName( string $sDomainName, boolean $bRemoveAllAccounts = false )
Delete domain from the database. For this to work, the domain should not hold any user accounts. Domain name is used for lookup.
Delete domain from the database. For this to work, the domain should not hold any user accounts. Domain name is used for lookup.
Parameters
- $sDomainName
- $bRemoveAllAccounts
- Default value is false.
Returns
boolean
|
public
array|false
|
#
getFullDomainsList( integer $iTenantId = 0 )
Get complete list of domains, without pagination.
Get complete list of domains, without pagination.
Parameters
- $iTenantId
- Default value is 0.
Returns
array|false
List of domains is returned like [IdDomain => [IsInternal, Name]], IsInternal is reserved for use in MailSuite Pro / Aurora.
|
public
array|false
|
#
getFilterList( integer $iTenantId = 0 )
Parameters
- $iTenantId
- Default value is 0.
Returns
array|false
|
public
array|false
|
#
getDomainsList( integer $iPage, integer $iDomainsPerPage, string $sOrderBy = 'name', boolean $bOrderType = true, string $sSearchDesc = '', integer $iTenantId = 0 )
Get list of domains, with pagination enabled.
Get list of domains, with pagination enabled.
Parameters
- $iPage
- Number of page to retrieve.
- $iDomainsPerPage
- Number of domains per page.
- $sOrderBy
- Default value is 'name'. Key field for sorting, name and email values are supported.
- $bOrderType
- Default value is true. Sort direction, true for ascending, false for descending.
- $sSearchDesc
- Default value is empty string. Filtering value. If not empty, only domains matching this value are returned.
- $iTenantId
- Default value is 0.
Returns
array|false
[IdDomain => [IsInternal, Name]] List of domains is returned like [IdDomain => [IsInternal, Name]], IsInternal is reserved for use in MailSuite Pro / Aurora.
|
public
array|false
|
#
getDomainIdsByTenantId( integer $iTenantId )
Parameters
Returns
array|false
|
public
CDomain|null
|
#
getDefaultDomainByTenantId( integer $iTenantId )
Retrieve information on default domain.
Retrieve information on default domain.
Parameters
Returns
|
public
array|false
|
#
setGlobalAddressBookVisibilityByTenantId( integer $iVisibility, integer $iTenantId )
Parameters
Returns
array|false
|
public
boolean
|
#
domainExists( string $sDomainName )
Check if domain exists in the database.
Check if domain exists in the database.
Parameters
- $sDomainName
- Domain name to look up.
Returns
boolean
|
public
integer|false
|
#
getDomainCount( string $sSearchDesc = '', integer $iTenantId = 0 )
Get number of domains, with optional filtering.
Get number of domains, with optional filtering.
Parameters
- $sSearchDesc
- Default value is empty string. If not empty, only domains matching the search value are counted.
- $iTenantId
- Default value is 0.
Returns
integer|false
|
CApiDomainsManager