CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($publicFolterObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  addMbox ($name)
  configQuotas ()
  getPublicFolderObj ()
  getSessionObj ()
  listMboxes ()
  removeMbox ($name)
  save ()

Member Function Documentation

PublicFolder::__get ( varName  ) 

Get 'name', the name of the public folder.

PublicFolder::__set ( varName,
varValue  
)

You can set member 'name' (the name of the public folder).

PublicFolder::addMbox ( name  ) 

this method adds a new Mbox

Returns:
bool
Parameters:
$name  string the new mbox name
PublicFolder::configQuotas (  ) 

this method returns quotas object

Returns:
object Quotas
PublicFolder::listMboxes (  ) 

this method returns an array with all the mboxes

Returns:
array
PublicFolder::removeMbox ( name  ) 

this method removes a mbox

Returns:
bool
Parameters:
$name  string mbox name to be removed
PublicFolder::save (  ) 

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

Returns:
bool