Class Forwards_Driver_sql

Description

Forwards_Driver_sql:: implements the Forwards_Driver API for SQL servers.

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

Copyright 2001-2009 The Horde Project (http://www.horde.org/)

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

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

Forwards_Driver
   |
   --Forwards_Driver_customsql
      |
      --Forwards_Driver_sql
Variable Summary
Method Summary
 Forwards_Driver_sql Forwards_Driver_sql (string $user, string $realm, [array $params = null])
 string currentTarget (string $password)
 void disableForwarding (string $password)
 void enableForwarding (string $password, string $target, boolean $keeplocal)
 mixed isEnabledForwarding (string $password)
 boolean isKeepLocal (string $password)
Variables
array $_requiredParams = array('phptype', 'table') (line 28)

List of required parameters.


Redefinition of:
Forwards_Driver_customsql::$_requiredParams
List of required parameters.

Inherited Variables

Inherited from Forwards_Driver_customsql

Forwards_Driver_customsql::$_connected
Forwards_Driver_customsql::$_db

Inherited from Forwards_Driver

Forwards_Driver::$_params
Forwards_Driver::$_realm
Forwards_Driver::$_user
Methods
Constructor Forwards_Driver_sql (line 37)

Constructor.

Forwards_Driver_sql Forwards_Driver_sql (string $user, string $realm, [array $params = null])
  • string $user: A user name.
  • string $realm: The realm of the user.
  • array $params: A hash containing connection parameters.
currentTarget (line 150)

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_customsql::currentTarget()
Retrieves current target of mail redirection for a user.
disableForwarding (line 78)

Stops forwarding of mail for a user.

void disableForwarding (string $password)
  • string $password: The password of the user.

Redefinition of:
Forwards_Driver_customsql::disableForwarding()
Stops forwarding of mail for a user.
enableForwarding (line 55)

Begins forwarding of mail for a user.

void enableForwarding (string $password, string $target, boolean $keeplocal)
  • 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_customsql::enableForwarding()
Begins forwarding of mail for a user.
isEnabledForwarding (line 99)

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_customsql::isEnabledForwarding()
Retrieves current state of mail redirection for a user.
isKeepLocal (line 128)

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_customsql::isKeepLocal()
Checks if user is keeping a local copy of forwarded mail.

Inherited Methods

Inherited From Forwards_Driver_customsql

 Forwards_Driver_customsql::Forwards_Driver_customsql()
 Forwards_Driver_customsql::currentTarget()
 Forwards_Driver_customsql::disableForwarding()
 Forwards_Driver_customsql::enableForwarding()
 Forwards_Driver_customsql::isEnabledForwarding()
 Forwards_Driver_customsql::isKeepLocal()
 Forwards_Driver_customsql::_buildUsername()
 Forwards_Driver_customsql::_connect()
 Forwards_Driver_customsql::_disableForwarding()
 Forwards_Driver_customsql::_enableForwarding()
 Forwards_Driver_customsql::_getUserDetails()

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()

Documentation generated on Sun, 30 Jan 2011 05:11:58 +0000 by phpDocumentor 1.4.3