Docs For Class Forwards_Driver

Description

Forwards_Driver_soap:: implements the Forwards_Driver API for SOAP services.

$Horde: forwards/lib/Driver/soap.php,v 1.8.2.4 2009/01/06 15:22:46 jan Exp $

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

author: Jan Schneider <jan@horde.org>
author: Marc Jauvin <marc@r4l.com>
since: Forwards 3.0

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

Forwards_Driver
   |
   --Forwards_Driver_soap

Variable Summary

array $_current_details

boolean $_initialised

Method Summary

string currentTarget (string $password)

void disableForwarding (string $password)

void enableForwarding (string $password, string $target, [boolean $keeplocal = false])

mixed isEnabledForwarding (string $password)

boolean isKeepLocal (string $password)

string _buildUsername ()

mixed _getUserDetails (string $password)

void _initialise ()

Variables

array $_current_details (line 28)

The information that was retrieved from the SOAP server.

boolean $_initialised = false (line 35)

Is the SOAP client initialized?

Inherited Variables

Inherited from Forwards_Driver

Forwards_Driver::$_params
Forwards_Driver::$_realm
Forwards_Driver::$_user

Methods

currentTarget (line 147)

Retrieves current target of mail redirection for a user.

return: The current forwarding mail address, false if no forwarding is set, or PEAR_Error on error.

string currentTarget (string $password)

string $password: The password of the user.

Redefinition of:

Forwards_Driver::currentTarget(): Retrieves current target of mail redirection for a user.

disableForwarding (line 75)

Stops forwarding of mail for a user.

void disableForwarding (string $password)

string $password: The password of the user.

Redefinition of:

Forwards_Driver::disableForwarding(): Stops forwarding of mail for a user.

enableForwarding (line 46)

Begins forwarding of mail for a user.

void enableForwarding (string $password, string $target, [boolean $keeplocal = false])

string $password: The password of the user.
string $target: The email address that mail should be forwarded to.
boolean $keeplocal: Keep a copy of forwarded mail in the local mailbox.

Redefinition of:

Forwards_Driver::enableForwarding(): Begins forwarding of mail for a user.

isEnabledForwarding (line 106)

Retrieves current state of mail redirection for a user.

return: Returns 'Y' if forwarding is enabled for the user, 'N' if forwarding is currently disabled, false if the status cannot be determined, and PEAR_Error on error.

mixed isEnabledForwarding (string $password)

string $password: The password of the user.

Redefinition of:

Forwards_Driver::isEnabledForwarding(): Retrieves current state of mail redirection for a user.

isKeepLocal (line 127)

Checks if user is keeping a local copy of forwarded mail.

return: True if user is keeping a local copy of mail, otherwise false.

boolean isKeepLocal (string $password)

string $password: The password of the user.

Redefinition of:

Forwards_Driver::isKeepLocal(): Checks if user is keeping a local copy of forwarded mail.

_buildUsername (line 165)

Builds a username based on presence of realm.

return: Fully qualified username.

string _buildUsername ()

_getUserDetails (line 182)

Retrieves user details from the backend.

return: SOAP result resource or PEAR_Error.

mixed _getUserDetails (string $password)

string $password: The password of the user.

_initialise (line 212)

Initialises the SOAP connection object.

void _initialise ()

Inherited Methods

Inherited From Forwards_Driver

Forwards_Driver::Forwards_Driver()
Forwards_Driver::currentTarget()
Forwards_Driver::disableForwarding()
Forwards_Driver::enableForwarding()
Forwards_Driver::factory()
Forwards_Driver::getUser()
Forwards_Driver::isEnabledForwarding()
Forwards_Driver::isKeepLocal()
Forwards_Driver::_makeEmailAddress()