CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($adminlimitsObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  addReservedRcpt ($reservedRcpt)
  addSubdomainMessageStorageLocation ($path)
  getAdminLimitsObj ()
  getServices ()
  getSessionObj ()
  listReservedRcpts ()
  listSubdomainMessageStorageLocations ()
  removeReservedRcpt ($reservedRcpt)
  removeSubdomainMessageStorageLocation ($path)
  save ()

Member Function Documentation

AdminLimits::__get ( varName  ) 

Get member.

member

description

maxAccounts

maxAccounts on domain admin limits

maxMaillists

maxMaillists on domain admin limits

maxGroups

maxGroups on domain admin limits

maxFolderRecipients

maxFolderRecipients on domain admin limits

maxAccountClasses

maxAccountClasses on domain admin limits

maxAccountMessageSizeQuota

maxAccountMessageSizeQuota on domain admin limits

maxAccountMessageCountQuota

maxAccountMessageCountQuota on domain admin limits

maxAccountFolderCountQuota

maxAccountFolderCountQuota on domain admin limits

maxAccountFolderMessageSizeQuota

maxAccountFolderMessageSizeQuota on domain admin limits

maxAccountFolderMessageCountQuota

maxAccountFolderMessageCountQuota on domain admin limits

maxMaillistMessageSizeQuota

maxMaillistMessageSizeQuota on domain admin limits

maxMaillistMessageCountQuota

maxMaillistMessageCountQuota on domain admin limits

maxMaillistFolderCountQuota

maxMaillistFolderCountQuota on domain admin limits

maxMaillistFolderMessageSizeQuota

maxMaillistFolderMessageSizeQuota on domain admin limits

maxMaillistFolderMessageCountQuota

maxMaillistFolderMessageCountQuota on domain admin limits

maxPublicFolderMessageSizeQuota

maxPublicFolderMessageSizeQuota on domain admin limits

maxPublicFolderMessageCountQuota

maxPublicFolderMessageCountQuota on domain admin limits

maxPublicFolderFolderCountQuota

maxPublicFolderFolderCountQuota on domain admin limits

maxPublicFolderFolderMessageSizeQuota

maxPublicFolderFolderMessageSizeQuota on domain admin limits

maxPublicFolderFolderMessageCountQuota

maxPublicFolderFolderMessageCountQuota on domain admin limits

maxSubdomains

maxSubdomains on domain admin limits

subdomainStorageLocation

subdomainStorageLocation on domain admin limits

subdomainObjectStorageLocation

subdomainObjectStorageLocation on domain admin limits

enableSmtpIncoming

the enable/disable status for SMTP Incoming

enableSmtpOutgoing

the enable/disable status for SMTP Outgoing

enablePop3

the enable/disable status for POP3

enableRpop

the enable/disable status for RPOP

enableImap

the enable/disable status for IMAP

enableWebmail

the enable/disable status for Webmail

purgeConstraint

the purge search constraint

purgeFolders

the allowed folders for purge (list is separated by , and names with spaces are between brackets)

maxActiveSyncMailboxCount

maxActiveSyncMailboxCount on domain admin limits

maxIAMailboxCount

maxIAMailboxCount on domain admin limits

maxKASMailboxCount

maxKASMailboxCount on domain admin limits

maxKAVMailboxCount

maxKAVMailboxCount on domain admin limits

maxOutlookConnectorMailboxCount

maxOutlookConnectorMailboxCount on domain admin limits

maxPersonalOrganizerMailboxCount

maxPersonalOrganizerMailboxCount on domain admin limits

maxPremiumMailboxCount

maxPersonalOrganizerMailboxCount on domain admin limits

maxSharingMailboxCount

maxSharingMailboxCount on domain admin limits

AdminLimits::__set ( varName,
varValue  
)

Set member.

member

description

maxAccounts

maxAccounts on domain admin limits

maxMaillists

maxMaillists on domain admin limits

maxGroups

maxGroups on domain admin limits

maxFolderRecipients

maxFolderRecipients on domain admin limits

maxAccountClasses

maxAccountClasses on domain admin limits

maxAccountMessageSizeQuota

maxAccountMessageSizeQuota on domain admin limits

maxAccountMessageCountQuota

maxAccountMessageCountQuota on domain admin limits

maxAccountFolderCountQuota

maxAccountFolderCountQuota on domain admin limits

maxAccountFolderMessageSizeQuota

maxAccountFolderMessageSizeQuota on domain admin limits

maxAccountFolderMessageCountQuota

maxAccountFolderMessageCountQuota on domain admin limits

maxMaillistMessageSizeQuota

maxMaillistMessageSizeQuota on domain admin limits

maxMaillistMessageCountQuota

maxMaillistMessageCountQuota on domain admin limits

maxMaillistFolderCountQuota

maxMaillistFolderCountQuota on domain admin limits

maxMaillistFolderMessageSizeQuota

maxMaillistFolderMessageSizeQuota on domain admin limits

maxMaillistFolderMessageCountQuota

maxMaillistFolderMessageCountQuota on domain admin limits

maxPublicFolderMessageSizeQuota

maxPublicFolderMessageSizeQuota on domain admin limits

maxPublicFolderMessageCountQuota

maxPublicFolderMessageCountQuota on domain admin limits

maxPublicFolderFolderCountQuota

maxPublicFolderFolderCountQuota on domain admin limits

maxPublicFolderFolderMessageSizeQuota

maxPublicFolderFolderMessageSizeQuota on domain admin limits

maxPublicFolderFolderMessageCountQuota

maxPublicFolderFolderMessageCountQuota on domain admin limits

maxSubdomains

maxSubdomains on domain admin limits

subdomainStorageLocation

subdomainStorageLocation on domain admin limits

subdomainObjectStorageLocation

subdomainObjectStorageLocation on domain admin limits

enableSmtpIncoming

the enable/disable status for SMTP Incoming

enableSmtpOutgoing

the enable/disable status for SMTP Outgoing

enablePop3

the enable/disable status for POP3

enableRpop

the enable/disable status for RPOP

enableImap

the enable/disable status for IMAP

enableWebmail

the enable/disable status for Webmail

purgeConstraint

the purge search constraint

purgeFolders

the allowed folders for purge (list is separated by , and names with spaces are between brackets)

maxActiveSyncMailboxCount

maxActiveSyncMailboxCount on domain admin limits

maxIAMailboxCount

maxIAMailboxCount on domain admin limits

maxKASMailboxCount

maxKASMailboxCount on domain admin limits

maxKAVMailboxCount

maxKAVMailboxCount on domain admin limits

maxOutlookConnectorMailboxCount

maxOutlookConnectorMailboxCount on domain admin limits

maxPersonalOrganizerMailboxCount

maxPersonalOrganizerMailboxCount on domain admin limits

maxPremiumMailboxCount

maxPersonalOrganizerMailboxCount on domain admin limits

maxSharingMailboxCount

maxSharingMailboxCount on domain admin limits

AdminLimits::addReservedRcpt ( reservedRcpt  ) 

adds a new reserved rcpt

Returns:
bool
Parameters:
$reservedRcpt  string the reserved rcpt
AdminLimits::addSubdomainMessageStorageLocation ( path  ) 

Adds a message storage location for this sub-domain

Returns:
bool
Parameters:
$path  string the message storage location path
AdminLimits::listReservedRcpts (  ) 

list the reserved rcpts

Returns:
array
AdminLimits::listSubdomainMessageStorageLocations (  ) 

List message storage locations for this sub-domain

Returns:
array
AdminLimits::removeReservedRcpt ( reservedRcpt  ) 

removes a reserved rcpt from list

Returns:
bool
Parameters:
$reservedRcpt  string the reserved rcpt
AdminLimits::removeSubdomainMessageStorageLocation ( path  ) 

Removes a message storage location for this sub-domain

Returns:
bool
Parameters:
$path  string the message storage location path
AdminLimits::save (  ) 

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

Returns:
bool