CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($imapProxyObj, $parent)
  __get ($name)
  __set ($name, $value)
  addListener ($address)
  configAccessControl ()
  getAllowStartTls ()
  getAuthenticateOnProxy ()
  getConnectionDataLocalInterface ()
  getConnectionDataMaxConnections ()
  getConnectionDataSslEnable ()
  getConnectionDataTimeout ()
  getGreetingsText ()
  getImapProxyObj ()
  getLogHost ()
  getLogLevel ()
  getLogType ()
  getMappingDataMappingHost ()
  getMappingDataMappingPort ()
  getMappingDataUsermapName ()
  getMaxAuthErrors ()
  getMaxConnThreads ()
  getMaxErrors ()
  getMinConnThreads ()
  getSessionObj ()
  getUserdbConnectorName ()
  getUserdbConnectorType ()
  listListeners ()
  removeListener ($address)
  reset ()
  save ()
  setAllowStartTls ($value)
  setAuthenticateOnProxy ($value)
  setConnectionDataLocalInterface ($value)
  setConnectionDataMaxConnections ($value)
  setConnectionDataSslEnable ($value)
  setConnectionDataTimeout ($value)
  setGreetingsText ($value)
  setLogHost ($value)
  setLogLevel ($value)
  setLogType ($value)
  setMappingDataMappingHost ($value)
  setMappingDataMappingPort ($value)
  setMappingDataUsermapName ($value)
  setMaxAuthErrors ($value)
  setMaxConnThreads ($value)
  setMaxErrors ($value)
  setMinConnThreads ($value)
  setUserdbConnectorName ($value)
  setUserdbConnectorType ($value)
  start ()
  stop ()
  updateListener ($address)

Member Function Documentation

ImapProxy::__get ( name  ) 

Get member.

member

description

maxConnThreads

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

minConnThreads

the minimum number of threads involved in I/O for the IMAP Proxy service

maxErrors

the maximum protocol errors number after which the connection is terminated

maxAuthErrors

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

allowStartTls

the secure connection (which start with STARTTLS)

authenticateOnProxy

if the authentication should be also done on proxy

mappingDataUsermapName

the mapping usermap name for the proxy

mappingDataMappingHost

the mapping data host for the proxy

mappingDataMappingPort

the mapping data port for the proxy

connectionDataTimeout

the timeout for the read/write operation

connectionDataMaxConnections

the maximum number of simultaneous connections

connectionDataSslEnable

if the connection should be SSL

connectionDataLocalInterface

the address of the interface used to make the connections

userdbConnectorType

the userdb connector type

userdbConnectorName

the userdb connector name

logLevel

the log level for the IMAP Proxy service

logHost

the address of the host that offers log services

logType

the log type for the IMAP Proxy service

greetingsText

the greeting text for this service

ImapProxy::__set ( name,
value  
)

Set member.

member

description

maxConnThreads

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

minConnThreads

the minimum number of threads involved in I/O for the IMAP Proxy service

maxErrors

the maximum protocol errors number after which the connection is terminated

maxAuthErrors

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

allowStartTls

the secure connection (which start with STARTTLS)

authenticateOnProxy

if the authentication should be also done on proxy

mappingDataUsermapName

the mapping usermap name for the proxy

mappingDataMappingHost

the mapping data host for the proxy

mappingDataMappingPort

the mapping data port for the proxy

connectionDataTimeout

the timeout for the read/write operation

connectionDataMaxConnections

the maximum number of simultaneous connections

connectionDataSslEnable

if the connection should be SSL

connectionDataLocalInterface

the address of the interface used to make the connections

userdbConnectorType

the userdb connector type

userdbConnectorName

the userdb connector name

logLevel

the log level for the IMAP Proxy service

logHost

the address of the host that offers log services

logType

the log type for the IMAP Proxy service

greetingsText

the greeting text for this service

ImapProxy::addListener ( address  ) 

This function adds a listener to this service

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

This function returns an access control object for this service

Returns:
object AccessControl
ImapProxy::listListeners (  ) 

This function lists the listeners for this service

Returns:
array
ImapProxy::removeListener ( address  ) 

This function removes a listener from this service

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

This function starts the IMAP service

Returns:
bool
ImapProxy::stop (  ) 

This function stops the IMAP service

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