CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($processingObj, $parent)
  __get ($name)
  __set ($name, $value)
  getDeliveryThreads ()
  getFilteringThreads ()
  getGreylistingCache ()
  getInternalQueueSize ()
  getLogHost ()
  getLogLevel ()
  getLogType ()
  getMailboxDisableInterval ()
  getMaxDirectoryCount ()
  getMaxMailScheduleInterval ()
  getMaxRetryCount ()
  getMessagesPerSecond ()
  getProcessingObj ()
  getQueuePath ()
  getQueueScheduleInterval ()
  getSessionObj ()
  reset ()
  save ()
  setDeliveryThreads ($value)
  setFilteringThreads ($value)
  setGreylistingCache ($value)
  setInternalQueueSize ($value)
  setLogHost ($value)
  setLogLevel ($value)
  setLogType ($value)
  setMailboxDisableInterval ($value)
  setMaxDirectoryCount ($value)
  setMaxMailScheduleInterval ($value)
  setMaxRetryCount ($value)
  setMessagesPerSecond ($value)
  setQueuePath ($value)
  setQueueScheduleInterval ($value)

Member Function Documentation

Processing::__get ( name  ) 

Get member.

member

description

maxMailScheduleInterval

the maximum interval for email rescheduling in case of a delivery error (in seconds)

queueScheduleInterval

the interval for queue checking

maxRetryCount

the maximum number of retries to deliver an email

deliveryThreads

the number of email delivery threads

internalQueueSize

the internal processing queue size (in number of messages)

messagesPerSecond

the maximum number of emails that a mailbox (folder) is allowed to receive in one second

mailboxDisableInterval

the number of seconds a mailbox (folder) is disabled if the "messages per second" limit is disabled

maxDirectoryCount

the maximum number of directories in the queue directory

queuePath

the path of the queue directory

logLevel

the log level for the processing service

logHost

the address of the host that offers log services

logType

the log type for the processing service

filteringThreads

number of threads handling the message filtering

greylistingCache

number of seconds a greylisted entry is kept in cache

Processing::__set ( name,
value  
)

Set member.

member

description

maxMailScheduleInterval

the maximum interval for email rescheduling in case of a delivery error (in seconds)

queueScheduleInterval

the interval for queue checking

maxRetryCount

the maximum number of retries to deliver an email

deliveryThreads

the number of email delivery threads

internalQueueSize

the internal processing queue size (in number of messages)

messagesPerSecond

the maximum number of emails that a mailbox (folder) is allowed to receive in one second

mailboxDisableInterval

the number of seconds a mailbox (folder) is disabled if the "messages per second" limit is disabled

maxDirectoryCount

the maximum number of directories in the queue directory

queuePath

the path of the queue directory

logLevel

the log level for the processing service

logHost

the address of the host that offers log services

logType

the log type for the processing service

filteringThreads

number of threads handling the message filtering

greylistingCache

number of seconds a greylisted entry is kept in cache