CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($activefilterObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  getActiveFilterObj ()
  getSessionObj ()
  save ()

Member Function Documentation

ActiveFilters::__get ( varName  ) 

Get member.

member

description

priority

the priority of the filter

filterName

the name of the filter as defined in the socket/script object set

filterType

type of the filter (to which the object set belongs)

applyOn

Specifies where this filter is activated (local, relay delivery or both) (available only on server filters)

fiteringOn

applies filter on levels: received|sent|sentAndReceived (available only on domain/accounts filters)

ActiveFilters::__set ( varName,
varValue  
)

Set member.

member

description

priority

the priority of the filter

filterName

the name of the filter as defined in the socket/script object set

filterType

type of the filter (to which the object set belongs)

applyOn

Specifies where this filter is activated (local, relay delivery or both) (available only on server filters)

fiteringOn

applies filter on levels: received|sent|sentAndReceived (available only on domain/accounts filters)

ActiveFilters::save (  ) 

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

Returns:
bool