CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($socketfilterObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  getSessionObj ()
  getSocketFilterObj ()
  save ()

Member Function Documentation

SocketFilters::__get ( varName  ) 

Get member.

member

description

name

sets the name of the filter

address

sets the address of the filter, used to communicate with the filter

protocolFile

sets the path to the ASFL file that describes the communication protocol

actionOnMatch

sets the action to be taken in case the filter matches an email

maxConnections

sets the maximum number of connections that will be made to the filter

idleTimeout

sets the inactivity timeout of the connection (in seconds)

maxMessageSize

the max message size

SocketFilters::__set ( varName,
varValue  
)

Set member.

member

description

name

sets the name of the filter

address

sets the address of the filter, used to communicate with the filter

protocolFile

sets the path to the ASFL file that describes the communication protocol

actionOnMatch

sets the action to be taken in case the filter matches an email

maxConnections

sets the maximum number of connections that will be made to the filter

idleTimeout

sets the inactivity timeout of the connection (in seconds)

maxMessageSize

the max message size

SocketFilters::save (  ) 

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

Returns:
bool