Docs For Class Vacation_Driver

Description

Vacation_Driver_plesk implements the Vacation_Driver API for Plesk control panel servers.

Plesk 8.1 or later is required.

$Horde: vacation/lib/Driver/plesk.php,v 1.10.2.4 2010/03/17 17:19:28 jan Exp $

See the enclosed file LICENSE for license information (BSD). If you did not receive this file, see http://www.horde.org/licenses/bsdl.php.

author: Jan Schneider <jan@horde.org>
link: http://swdn.swsoft.com/en/library/plesk/
since: Vacation 3.1

Located in /lib/Driver/plesk.php (line 21)

Vacation_Driver
   |
   --Vacation_Driver_plesk

Variable Summary

array $capabilities

resource $_curl

array $_details

integer $_domain_id

Method Summary

string currentFrom (string $password)

mixed getParam (string $param)

void setVacation (string $password, string $message, string $subject, string $from, [string $alias = ''])

void unsetVacation (string $password)

void _checkConfig (string $password)

mixed _getUserDetails (string $password)

void _parseResponse (Horde_DOM_Node $node, &$array, array $array)

boolean _request (string $password, string $packet)

Variables

array $capabilities = array('changeFrom' => false) (line 31)

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.

'changeFrom' permits the user to change the From: header.

Redefinition of:

Vacation_Driver::$capabilities: An array of capabilities, so that the driver can report which operations it supports and which it doesn't.

resource $_curl (line 38)

The curl resource handler

array $_details = null (line 52)

The current vacation details.

integer $_domain_id (line 45)

The Plesk domain id of the current realm.

Inherited Variables

Inherited from Vacation_Driver

Vacation_Driver::$_from
Vacation_Driver::$_message
Vacation_Driver::$_params
Vacation_Driver::$_realm
Vacation_Driver::$_subject
Vacation_Driver::$_user

Methods

currentFrom (line 169)

Retrieves current vacation From: address.

return: The current or default vacation From: address.

string currentFrom (string $password)

string $password: The password for user.

Redefinition of:

Vacation_Driver::currentFrom(): Retrieves current vacation From: address.

getParam (line 61)

Returns a parameter value.

return: The parameter value, or null if not found.

mixed getParam (string $param)

string $param: The parameter to check in.

Redefinition of:

Vacation_Driver::getParam(): Return a parameter value.

setVacation (line 79)

Setup vacation notices for a user.

void setVacation (string $password, string $message, string $subject, string $from, [string $alias = ''])

string $password: The password for the user.
string $message: The text of the vacation notice.
string $subject: The subject of the vacation notice.
string $from: The From: address of the vacation notice.
string $alias: Alias email address -- Not yet implemented in backends.

Redefinition of:

Vacation_Driver::setVacation(): Sets up vacation notices for a user.

unsetVacation (line 125)

Removes any existing vacation notices.

void unsetVacation (string $password)

string $password: The password of the user.

Redefinition of:

Vacation_Driver::unsetVacation(): Disables vacation notices for a user.

_checkConfig (line 233)

Checks if the realm has a specific configuration. If not, tries to fall back on the default configuration. If still not a valid configuration then returns an error.

void _checkConfig (string $password)

string $password: The password for the user.

_getUserDetails (line 181)

Retrieves the current vacation details for the user.

return: Vacation details, or PEAR_Error.

mixed _getUserDetails (string $password)

string $password: The password for user.

Redefinition of:

Vacation_Driver::_getUserDetails(): Retrieves the current vacation details for the user.

_parseResponse (line 326)

Parses the XML response body of the Plesk API call into a hash.

void _parseResponse (Horde_DOM_Node $node, &$array, array $array)

Horde_DOM_Node $node: A DOM node object.
array $array: The result hash.
&$array

_request (line 282)

Connects to the Plesk RPC API server and sends a request.

return: True on success, PEAR_Error otherwise.

boolean _request (string $password, string $packet)

string $password: The password to connect with.
string $packet: The XML fragment for the request.

Inherited Methods

Inherited From Vacation_Driver

Vacation_Driver::Vacation_Driver()
Vacation_Driver::currentFrom()
Vacation_Driver::currentMessage()
Vacation_Driver::currentSubject()
Vacation_Driver::factory()
Vacation_Driver::getFrom()
Vacation_Driver::getParam()
Vacation_Driver::getUser()
Vacation_Driver::hasCapability()
Vacation_Driver::isEnabled()
Vacation_Driver::setVacation()
Vacation_Driver::unsetVacation()
Vacation_Driver::_buildMessage()
Vacation_Driver::_encryptPassword()
Vacation_Driver::_getUserDetails()
Vacation_Driver::_makeEmailAddress()
Vacation_Driver::_parseMessage()
Vacation_Driver::_processMessage()