Class Forwards_Driver_postfixadmin

Description

Forwards_Driver_postfixadmin implements the Forwards_Driver API for SQL servers managed by Postfix Admin (http://postfixadmin.sourceforge.net/).

$Horde: forwards/lib/Driver/postfixadmin.php,v 1.2.2.2 2009/12/17 11:11:09 jan Exp $

Copyright 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/postfixadmin.php (line 20)

Forwards_Driver
   |
   --Forwards_Driver_customsql
      |
      --Forwards_Driver_postfixadmin
Variable Summary
Method Summary
 Forwards_Driver_postfixadmin Forwards_Driver_postfixadmin (string $user,  $realm, array $params)
 string currentTarget (string $password)
 void enableForwarding (string $password, string $target, boolean $keeplocal)
 boolean isKeepLocal (string $password)
Variables
array $_requiredParams = array('phptype') (line 27)

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_postfixadmin (line 35)

Constructor.

Forwards_Driver_postfixadmin Forwards_Driver_postfixadmin (string $user,  $realm, array $params)
  • string $user: A user name.
  • array $params: Configuration parameters for the backend.
  • $realm
currentTarget (line 97)

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.
enableForwarding (line 56)

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.
isKeepLocal (line 76)

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