CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($pop3Obj, $parent)
  __get ($name)
  __set ($name, $value)
  addListener ($address)
  configAccessControl ()
  getAllowStartTls ()
  getGreetingsText ()
  getLogHost ()
  getLogLevel ()
  getLogType ()
  getMaxAuthErrors ()
  getMaxConnThreads ()
  getMaxErrors ()
  getMinConnThreads ()
  getPlainConnectionAllowLogin ()
  getPlainConnectionAuthTypes ()
  getPop3Obj ()
  getSecureConnectionAllowLogin ()
  getSecureConnectionAuthTypes ()
  getSessionObj ()
  getUserdbConnectorName ()
  getUserdbConnectorType ()
  listListeners ()
  removeListener ($address)
  reset ()
  save ()
  setAllowStartTls ($value)
  setGreetingsText ($value)
  setLogHost ($value)
  setLogLevel ($value)
  setLogType ($value)
  setMaxAuthErrors ($value)
  setMaxConnThreads ($value)
  setMaxErrors ($value)
  setMinConnThreads ($value)
  setPlainConnectionAllowLogin ($value)
  setPlainConnectionAuthTypes ($value)
  setSecureConnectionAllowLogin ($value)
  setSecureConnectionAuthTypes ($value)
  setUserdbConnectorName ($value)
  setUserdbConnectorType ($value)
  start ()
  stop ()
  updateListener ($address)

Member Function Documentation

Pop3::__get ( name  ) 

Get member.

member

description

maxConnThreads

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

minConnThreads

the minimum number of threads involved in I/O for the POP3 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

allowStartTls

the secure connection (which starts with STARTTLS)

secureConnectionAllowLogin

if plain text authentication is allowed on secure connections

secureConnectionAuthTypes

the allowed authentication methods on a secure connection

plainConnectionAuthTypes

the allowed authentication methods on a plain connection

plainConnectionAllowLogin

if plain text authentication is allowed on plain connections

userdbConnectorType

the userdb connector type

userdbConnectorName

the userdb connector name

logLevel

the log level for the POP3 service

logHost

the address of the host that offers log services

logType

the log type for the POP3 service

greetingsText

the greeting text for this service

Pop3::__set ( name,
value  
)

Set member.

member

description

maxConnThreads

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

minConnThreads

the minimum number of threads involved in I/O for the POP3 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

allowStartTls

the secure connection (which starts with STARTTLS)

secureConnectionAllowLogin

if plain text authentication is allowed on secure connections

secureConnectionAuthTypes

the allowed authentication methods on a secure connection

plainConnectionAuthTypes

the allowed authentication methods on a plain connection

plainConnectionAllowLogin

if plain text authentication is allowed on plain connections

userdbConnectorType

the userdb connector type

userdbConnectorName

the userdb connector name

logLevel

the log level for the POP3 service

logHost

the address of the host that offers log services

logType

the log type for the POP3 service

greetingsText

the greeting text for this service

Pop3::addListener ( address  ) 

This function adds a listener to this service

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

This function returns an access control object for this service

Returns:
object AccessControl
Pop3::listListeners (  ) 

This function lists the listeners for this service

Returns:
array
Pop3::removeListener ( address  ) 

This function removes a listener from this service

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

This function starts the POP3 service

Returns:
bool
Pop3::stop (  ) 

This function stops the POP3 service

Returns:
bool
Pop3::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)