Class Forwards_Driver

Description

Forwards_Driver:: defines an API for implementing forwarding backends for Forwards.

$Horde: forwards/lib/Driver.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.php (line 18)


	
			
Direct descendents
Class Description
 class Forwards_Driver_customsql Forwards_Driver_sql:: implements the Forwards_Driver API for SQL servers.
 class Forwards_Driver_forwards Forwards_Driver_forwards:: implements the Forwards_Driver API for ftp driven dot-forward compliant mail servers.
 class Forwards_Driver_ldap Forwards_Driver_ldap:: implements the Forwards_Driver API for LDAP driven mail servers.
 class Forwards_Driver_mdaemon Forwards_Driver_mdaemon:: implements the Forwards_Driver API for the Mdaemon mail servers.
 class Forwards_Driver_plesk Forwards_Driver_plesk implements the Forwards_Driver API for Plesk control panel servers.
 class Forwards_Driver_soap Forwards_Driver_soap:: implements the Forwards_Driver API for SOAP services.
Variable Summary
 array $_params
 string $_realm
 string $_user
Method Summary
 Forwards_Driver Forwards_Driver (string $user, string $realm, [array $params = null])
 string currentTarget (string $password)
 void disableForwarding (string $password)
 void enableForwarding (string $password, string $target, [boolean $keeplocal = false])
 Forwards_Driver factory (string $user, string $realm, [string $driver = null], [array $params = null])
 string getUser ()
 mixed isEnabledForwarding (string $password)
 boolean isKeepLocal (string $password)
 string _makeEmailAddress (string $user, string $realm)
Variables
array $_params (line 39)

Hash containing configuration data.

string $_realm (line 32)

The user's realm.

string $_user (line 25)

The current user name.

Methods
Constructor Forwards_Driver (line 48)

Constructor.

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

Retrieves current target of mail redirection for a user.

  • return: The current forwarding mail address, or PEAR_Error on error.
  • abstract:
string currentTarget (string $password)
  • string $password: The password of the user.

Redefined in descendants as:
disableForwarding (line 94)

Stops forwarding of mail for a user.

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

Redefined in descendants as:
enableForwarding (line 82)

Begins forwarding of mail for a user.

  • abstract:
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.

Redefined in descendants as:
factory (line 199)

Gets a concrete Forwards_Driver instance.

  • return: The newly created concrete Forwards_Driver instance, or false on error.
Forwards_Driver factory (string $user, string $realm, [string $driver = null], [array $params = null])
  • string $user: A user name.
  • string $realm: The realm of the user.
  • string $driver: The type of concrete Forwards_Driver subclass to return. The code for the driver is dynamically included.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.
getUser (line 66)

Returns the current user.

  • return: The current user name.
string getUser ()
isEnabledForwarding (line 110)

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.
  • abstract:
mixed isEnabledForwarding (string $password)
  • string $password: The password of the user.

Redefined in descendants as:
isKeepLocal (line 125)

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

  • return: True if user is keeping a local copy of mail, otherwise false.
  • abstract:
boolean isKeepLocal (string $password)
  • string $password: The password of the user.

Redefined in descendants as:
_makeEmailAddress (line 156)

Parses an email address list and returns it in a known standard form.

This will attempt to add the domain (realm) to unqualified addresses if the realm is non-blank and not 'default'.

  • return: The email address(es) on success, false on error.
string _makeEmailAddress (string $user, string $realm)
  • string $user: The email address.
  • string $realm: The domain/realm to add if none is present.

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