CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($groupObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  addAddress ($name)
  configFilters ()
  getGroupObj ()
  getSessionObj ()
  listAddresses ()
  registryInformation ()
  removeAddress ($name)
  resetLdapAssociation ()
  save ()

Member Function Documentation

Group::__get ( varName  ) 

Get member.

member

description

name

the group's name - only usable in an UPDATE operation

enable

enabled/disabled status for the group

publishContactInfo

the enabled/disabled publish contact info

distributeEmailTo

specify group's email distribution target

membersSendEmailAsGroup

desc allow members to use group's email address as sender address

receiveEmailFrom

specify who is allowed to send emails to this group

Group::__set ( varName,
varValue  
)

Set member.

member

description

name

the group's name - only usable in an UPDATE operation

enable

enabled/disabled status for the group

publishContactInfo

the enabled/disabled publish contact info

distributeEmailTo

specify group's email distribution target

membersSendEmailAsGroup

desc allow members to use group's email address as sender address

receiveEmailFrom

specify who is allowed to send emails to this group

Group::addAddress ( name  ) 

adds an address for the group

Returns:
bool
Parameters:
$name  string The new address
Group::configFilters (  ) 

this method returns an object of Filters type for the selected group

Returns:
object Filters
Group::listAddresses (  ) 

returns an array with addresses for the current group

Returns:
array
Group::registryInformation (  ) 

returns an array with registry information

Returns:
array
Group::removeAddress ( name  ) 

removes an address from the group

Returns:
bool
Parameters:
$name  string The address to be removed from group
Group::resetLdapAssociation (  ) 

resets the ldap associations

Returns:
bool
Group::save (  ) 

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

Returns:
bool