CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($limitObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  getLimitObj ()
  getLimitServicesObj ()
  getSessionObj ()
  inherit ($varName)
  isInherited ($varName)
  save ()

Member Function Documentation

Limits::__get ( varName  ) 

Set member.

member

description

sentMessagesCount

the maximum number of mails a user can send in a specified interval

sentRecipientsCount

the maximum number of recipients of emails in a specified interval

sentOverquotaFileName

the name of the eml template used in case of overquota

sentOverquotaEmailAddress

the email address used for sending overquota notifications

sentMessagesSize

the maximum size of mails a user can send in a specified interval

sentMessagesInterval

the specified interval in seconds

pop3ConnectionCount

the number of simultaneous POP3 connections

imapConnectionCount

the number of simultaneous IMAP connections

webmailRcptCount

the maximum number of recipients for an email composed using Webmail

webmailSessionCount

the maximum simultaneous Webmail sessions

webmailAttSize

the size limit of an attachment that can be uploaded using Webmail

webmailAttCount

the maximum number of attachments for a mail composed in Webmail

webmailMessageSize

the size limit for a mail (body + attachments) composed in Webmail

rpopConnectionCount

the maximum number of RPOP connections a user is allowed to define

rpopRetrievalInterval

the minimum time interval (in minutes) between two RPOP retrievals on the same connection

maillistUserCount

mail list user count

passwordEnforcementEnabled

the enabled/disabled status for the Password Enforcement policy

passwordRecoveryMethods

the methods for password recovery feature (valid methods: secretQuestion, peaBased)

usernameRecoveryMethods

the methods for username recovery feature (valid methods: peaBased)

passwordRecoveryFileName

the eml file for password recovery feature

usernameRecoveryFileName

the eml file for username recovery feature

minimumPasswordLength

the minimum size of the password

maximumPasswordLength

the maximum size of the password

requiredPasswordCharacters

the required characters for setting a password

htmlFilterLevel

the security level for a HTML mail body (0-3)

temporaryAliasesCount

the temporary email address count limit

temporaryAliasesInterval

the temporary email address duration limit

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

enableActiveSync

enable/disable ActiveSync

activeSyncOptions

ActiveSync options. Values: email contact pim (separated by space)

enableOutlookConnector

enabled/disabled Outlook Connector

enablePersonalOrganizer

enabled/disabled Personal Organizer

quotaSendMessageThreshold

the percent of used quota which blocks user from sending messages (avaible only for maillist)

passExpirationEnabled

enabled/disabled password expiration

passExpirationInterval

the interval of time in days that may pass from the moment the password was changed until the moment it expires and can not be used

passRenewalInterval

the interval of time that must pass from the moment of the last change of the password until a new change can be performed

passExpirationWarningEnabled

enabled/disabled sending of a warning message in case of password expiration

passExpirationWarningInterval

the interval of time in days after which warning message is send

passExpirationWarningSubject

the subject template of the email message sent as warning for password expiration

passExpirationWarningSentDaily

enabled/disabled the password expiration warning to be sent every day during the expiration warning interval

passHistorySize

the number of consecutive changed passwords that can not be used as new password when a change of password is performed

passUnchangeable

enabled/disabled the capability for an user to change his/her password

welcomeMessageEnabled

enabled/disabled the post of a welcome message in an account's mailbox

welcomeMessageSubject

the subject template of the email message sent as welcome message

passExpirationWarningBody

the body template of the email message sent as warning for password expiration

welcomeMessageBody

the body template of the email message sent as welcome message

allowIdentityConfirmation

enabled/disabled the use of Identity Confirmation

editableContactInfo

enabled/disabled contact info being editable

enableAutoMigration

enabled/disabled account's auto migration

enableSharing

enabled/disabled sharing

enableKAS

enabled/disabled KAS

enableKAV

enabled/disabled KAV

Limits::__set ( varName,
varValue  
)

Get member.

member

description

sentMessagesCount

the maximum number of mails a user can send in a specified interval

sentRecipientsCount

the maximum number of recipients of emails in a specified interval

sentOverquotaFileName

the name of the eml template used in case of overquota

sentOverquotaEmailAddress

the email address used for sending overquota notifications

sentMessagesSize

the maximum size of mails a user can send in a specified interval

sentMessagesInterval

the specified interval in seconds

pop3ConnectionCount

the number of simultaneous POP3 connections

imapConnectionCount

the number of simultaneous IMAP connections

webmailRcptCount

the maximum number of recipients for an email composed using Webmail

webmailSessionCount

the maximum simultaneous Webmail sessions

webmailAttSize

the size limit of an attachment that can be uploaded using Webmail

webmailAttCount

the maximum number of attachments for a mail composed in Webmail

webmailMessageSize

the size limit for a mail (body + attachments) composed in Webmail

rpopConnectionCount

the maximum number of RPOP connections a user is allowed to define

rpopRetrievalInterval

the minimum time interval (in minutes) between two RPOP retrievals on the same connection

maillistUserCount

mail list user count

passwordEnforcementEnabled

the enabled/disabled status for the Password Enforcement policy

passwordRecoveryMethods

the methods for password recovery feature (valid methods: secretQuestion, peaBased)

usernameRecoveryMethods

the methods for username recovery feature (valid methods: peaBased)

passwordRecoveryFileName

the eml file for password recovery feature

usernameRecoveryFileName

the eml file for username recovery feature

minimumPasswordLength

the minimum size of the password

maximumPasswordLength

the maximum size of the password

requiredPasswordCharacters

the required characters for setting a password

htmlFilterLevel

the security level for a HTML mail body (0-3)

temporaryAliasesCount

the temporary email address count limit

temporaryAliasesInterval

the temporary email address duration limit

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

enableActiveSync

enable/disable ActiveSync

activeSyncOptions

ActiveSync options. Values: email contact pim (separated by space)

enableOutlookConnector

enabled/disabled Outlook Connector

enablePersonalOrganizer

enabled/disabled Personal Organizer

quotaSendMessageThreshold

the percent of used quota which blocks user from sending messages (avaible only for maillist)

passExpirationEnabled

enabled/disabled password expiration

passExpirationInterval

the interval of time in days that may pass from the moment the password was changed until the moment it expires and can not be used

passRenewalInterval

the interval of time that must pass from the moment of the last change of the password until a new change can be performed

passExpirationWarningEnabled

enabled/disabled sending of a warning message in case of password expiration

passExpirationWarningInterval

the interval of time in days after which warning message is send

passExpirationWarningSubject

the subject template of the email message sent as warning for password expiration

passExpirationWarningSentDaily

enabled/disabled the password expiration warning to be sent every day during the expiration warning interval

passHistorySize

the number of consecutive changed passwords that can not be used as new password when a change of password is performed

passUnchangeable

enabled/disabled the capability for an user to change his/her password

welcomeMessageEnabled

enabled/disabled the post of a welcome message in an account's mailbox

welcomeMessageSubject

the subject template of the email message sent as welcome message

passExpirationWarningBody

the body template of the email message sent as warning for password expiration

welcomeMessageBody

the body template of the email message sent as welcome message

allowIdentityConfirmation

enabled/disabled the use of Identity Confirmation

editableContactInfo

enabled/disabled contact info being editable

enableAutoMigration

enabled/disabled account's auto migration

enableSharing

enabled/disabled sharing

enableKAS

enabled/disabled KAS

enableKAV

enabled/disabled KAV

Limits::inherit ( varName  ) 

the variable to inherit from selected source

Returns:
bool
Parameters:
$varName  string the variable
Limits::isInherited ( varName  ) 

checks if the variable is inherited

Note:
returns (1 if the value is inherited, 0 if not, or -1 if this does not apply to the current limits object)
Returns:
int
Parameters:
$varName  string the variable
Limits::save (  ) 

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

Returns:
bool