Class Gadget_Service_Mailaccount

Description

Gadget_Service_Mailaccount

Gadget Service for Mail Account Operations.

  • since: 1.0

Located in /Gadget/Service/Mailaccount.php (line 31)

Gadget_Plugin
   |
   --Gadget_Service
      |
      --Gadget_Service_Mailaccount
Variable Summary
string $account
object $client
string $domain
string $fault
string $method
string $service
Method Summary
bool@PEAR_Error addDomain (string $domain, string $password)
bool|PEAR_Error addUser (string $user, string $password, [string $fullname = ''])
bool|PEAR_Error auth (string $user, string $password)
mixed batch (mixed $action, mixed $params)
bool|PEAR_Error checkAuth (string $user, string $password)
bool|PEAR_Error delDomain (string $domain)
bool|PEAR_Error delUser (string $user)
bool execute (mixed $params)
array flatten (array &$struct)
void init ()
mixed listDomain ([mixed $domain = null])
mixed listDomains ()
mixed listUser (mixed $user)
mixed listUsers ([mixed $domain = null], mixed $offset, mixed $limit, [mixed $sort = true])
mixed modUser (mixed $user, [mixed $fullname = null], [mixed $flags = null])
bool onFailure ()
bool onSuccess ()
bool|PEAR_Error passwd (string $user, string $password)
array|PEAR_Error rpcArray (string $action, [string $params = array()])
bool|PEAR_Error rpcScalar (string $action, [array $params = array()])
array|PEAR_Error rpcStruct (string $action, [string $params = array()])
string safeName (string $name)
bool|PEAR_Error setQuota (string $user, string $quota)
void userDomain (array &$params, string $user)
Variables
string $account (line 66)

Mail Account

object $client (line 52)

XML_RPC Client

string $domain (line 73)

Mail Domain

string $fault (line 45)

Occured Fault Message

string $method (line 59)

XMLRPC Method

string $service = SERVICE_MAILACCOUNT (line 38)

Service


Redefinition of:
Gadget_Service::$service
Service

Inherited Variables

Inherited from Gadget_Service

Gadget_Service::$plugin
Methods
addDomain (line 277)

Add Domain

  • access: public
bool@PEAR_Error addDomain (string $domain, string $password)
  • string $domain
  • string $password
addUser (line 227)

Add User

  • access: public
bool|PEAR_Error addUser (string $user, string $password, [string $fullname = ''])
  • string $user
  • string $password
  • string $fullname
auth (line 196)

Auth

  • access: public
bool|PEAR_Error auth (string $user, string $password)
  • string $user
  • string $password
batch (line 370)

Batch Processing

  • access: public
mixed batch (mixed $action, mixed $params)
checkAuth (line 211)

Check Password

  • access: public
bool|PEAR_Error checkAuth (string $user, string $password)
  • string $user
  • string $password
delDomain (line 290)

Delete Domain

  • access: public
bool|PEAR_Error delDomain (string $domain)
  • string $domain
delUser (line 248)

Delete User

  • access: public
bool|PEAR_Error delUser (string $user)
  • string $user
execute (line 102)

Execute

  • access: protected
bool execute (mixed $params)
flatten (line 524)

Flatten Structure

  • access: protected
array flatten (array &$struct)
  • array $struct
init (line 81)

Init

  • access: protected
void init ()

Redefinition of:
Gadget_Plugin::init()
Init
listDomain (line 331)

List Domain

  • access: public
mixed listDomain ([mixed $domain = null])
listDomains (line 320)

List Domains

  • access: public
mixed listDomains ()
listUser (line 343)

List User

  • access: public
mixed listUser (mixed $user)
listUsers (line 301)

List Users

  • access: public
mixed listUsers ([mixed $domain = null], mixed $offset, mixed $limit, [mixed $sort = true])
modUser (line 355)

Mod User

  • access: public
mixed modUser (mixed $user, [mixed $fullname = null], [mixed $flags = null])
onFailure (line 563)

On Failure

  • return: false
  • access: protected
bool onFailure ()

Redefinition of:
Gadget_Service::onFailure()
On Failure
onSuccess (line 552)

On Success

  • return: true
  • access: protected
bool onSuccess ()

Redefinition of:
Gadget_Service::onSuccess()
On Success
passwd (line 181)

Change Password

  • access: public
bool|PEAR_Error passwd (string $user, string $password)
  • string $user
  • string $password
rpcArray (line 450)

RPC with array return value

  • access: protected
array|PEAR_Error rpcArray (string $action, [string $params = array()])
  • string $action
  • string $params
rpcScalar (line 416)

RPC with scalar return value

  • access: protected
bool|PEAR_Error rpcScalar (string $action, [array $params = array()])
  • string $action
  • array $params
rpcStruct (line 433)

RPC with struct return value

  • access: protected
array|PEAR_Error rpcStruct (string $action, [string $params = array()])
  • string $action
  • string $params
safeName (line 576)

Safe Name

  • access: public
  • static:
string safeName (string $name)
  • string $name
setQuota (line 262)

Set Quota

  • access: public
bool|PEAR_Error setQuota (string $user, string $quota)
  • string $user
  • string $quota
userDomain (line 397)

User Domain

  • access: protected
void userDomain (array &$params, string $user)
  • array &$params
  • string $user

Inherited Methods

Inherited From Gadget_Service

Gadget_Service::configure()
Gadget_Service::lookup()
Gadget_Service::onFailure()
Gadget_Service::onSuccess()
Gadget_Service::register()
Gadget_Service::run()
Gadget_Service::singleton()

Inherited From Gadget_Plugin

Gadget_Plugin::Gadget_Plugin()
Gadget_Plugin::configure()
Gadget_Plugin::init()
Gadget_Plugin::lookup()
Gadget_Plugin::register()
Gadget_Plugin::singleton()

Documentation generated on Sun, 03 Jul 2005 12:45:52 +0200 by phpDocumentor 1.3.0RC3