Class Forwards_Driver_ldap

Description

Forwards_Driver_ldap:: implements the Forwards_Driver API for LDAP driven mail servers.

$Horde: forwards/lib/Driver/ldap.php,v 1.10.2.5 2009/04/04 10:10:56 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/ldap.php (line 18)

Forwards_Driver
   |
   --Forwards_Driver_ldap
Variable Summary
 boolean $_connected
 resource $_connection
 string $_dn
 string $_password
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)
 void _checkConfig ()
 mixed _connect ( $password)
 mixed _getForwardInfo ()
 array _getSchemaAttrs ()
 integer _rebindProc ( $conn,  $who)
Variables
boolean $_connected = false (line 32)

Boolean true if connected, false otherwise

resource $_connection (line 25)

Pointer to the ldap connection.

string $_dn (line 39)

The current user's corresponding distinguished name

string $_password (line 46)

The current user's password

Inherited Variables

Inherited from Forwards_Driver

Forwards_Driver::$_params
Forwards_Driver::$_realm
Forwards_Driver::$_user
Methods
currentTarget (line 244)

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

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

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

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

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.
_checkConfig (line 624)

Check if the realm has a specific configuration.

If not, try to fall back on the default configuration. If still not a valid configuration then exit with an error.

void _checkConfig ()
_connect (line 409)

Opens a connection to the LDAP server.

  • return: True on success or a PEAR_Error object on failure.
mixed _connect ( $password)
  • $password
_getForwardInfo (line 264)

Get the forwarding information for the requested user

  • return: Array of forwarding data on succes, false on failure
mixed _getForwardInfo ()
_getSchemaAttrs (line 385)

Get the attributes for storing forward addresses and local delivery option based on the configured schema.

  • return: List of attributes (forwardsattr, keeplocalattr)
array _getSchemaAttrs ()
_rebindProc (line 571)

Callback function for LDAP referrals.

This function is called when an LDAP operation returns a referral to an alternate server.

  • return: 1 on error, 0 on success.
integer _rebindProc ( $conn,  $who)
  • $conn
  • $who

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

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