CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($smtpInObj, $parent)
  __get ($name)
  __set ($name, $value)
  addListener ($address)
  configAccessControl ()
  getEnableSmtpRouting ()
  getLogHost ()
  getLogLevel ()
  getLogType ()
  getMappingDataMappingHost ()
  getMappingDataMappingPort ()
  getMappingDataUsermapName ()
  getMaxAuthErrors ()
  getMaxConnThreads ()
  getMaxErrors ()
  getMaxReceivedHeaders ()
  getMinConnThreads ()
  getSessionObj ()
  getSmtpInObj ()
  getUserdbConnectorName ()
  getUserdbConnectorType ()
  listListeners ()
  removeListener ($address)
  reset ()
  save ()
  setEnableSmtpRouting ($value)
  setLogHost ($value)
  setLogLevel ($value)
  setLogType ($value)
  setMappingDataMappingHost ($value)
  setMappingDataMappingPort ($value)
  setMappingDataUsermapName ($value)
  setMaxAuthErrors ($value)
  setMaxConnThreads ($value)
  setMaxErrors ($value)
  setMaxReceivedHeaders ($value)
  setMinConnThreads ($value)
  setUserdbConnectorName ($value)
  setUserdbConnectorType ($value)
  start ()
  stop ()
  updateListener ($address)

Member Function Documentation

SmtpIn::__get ( name  ) 

Get member.

member

description

maxConnThreads

the maximum number of threads involved in I/O for the SMTP Incoming service

minConnThreads

the minimum number of threads involved in I/O for the SMTP Incoming service

maxErrors

the maximum number of protocol errors after which the connection is terminated

maxAuthErrors

the maximum number of authentication errors after which the connection is terminated

maxReceivedHeaders

the maximum number of headers that an email received by Axigen can have

enableSmtpRouting

the enabled/disabled status for SMTP Routing

mappingDataUsermapName

the mapping usermap name for the proxy

mappingDataMappingHost

the mapping data host for the proxy

mappingDataMappingPort

the mapping data port for the proxy

userdbConnectorType

the type of the userdb connector

userdbConnectorName

the name of the userdb connector

logLevel

the log level for the SMTP Incoming service

logHost

the address of the host that offers log services

logType

the log type for the SMTP Incoming service

SmtpIn::__set ( name,
value  
)

Set member.

member

description

maxConnThreads

the maximum number of threads involved in I/O for the SMTP Incoming service

minConnThreads

the minimum number of threads involved in I/O for the SMTP Incoming service

maxErrors

the maximum number of protocol errors after which the connection is terminated

maxAuthErrors

the maximum number of authentication errors after which the connection is terminated

maxReceivedHeaders

the maximum number of headers that an email received by Axigen can have

enableSmtpRouting

the enabled/disabled status for SMTP Routing

mappingDataUsermapName

the mapping usermap name for the proxy

mappingDataMappingHost

the mapping data host for the proxy

mappingDataMappingPort

the mapping data port for the proxy

userdbConnectorType

the type of the userdb connector

userdbConnectorName

the name of the userdb connector

logLevel

the log level for the SMTP Incoming service

logHost

the address of the host that offers log services

logType

the log type for the SMTP Incoming service

SmtpIn::addListener ( address  ) 

This function adds a listener to this service

Returns:
bool
Parameters:
$address  string the listener address (ex: 127.0.0.1:25)
SmtpIn::configAccessControl (  ) 

This function returns an access control object for this service

Returns:
object AccessControl
SmtpIn::listListeners (  ) 

This function lists the listeners for this service

Returns:
array
SmtpIn::removeListener ( address  ) 

This function removes a listener from this service

Returns:
bool
Parameters:
$address  string the listener address (ex: 127.0.0.1:25)
SmtpIn::start (  ) 

This function starts the SMTP Incoming service

Returns:
bool
SmtpIn::stop (  ) 

This function stops the SMTP Incoming service

Returns:
bool
SmtpIn::updateListener ( address  ) 

This function updates a listener of this service

Returns:
object Listener
Parameters:
$address  string the listener address (ex: 127.0.0.1:25)