Class Forwards_Driver_forwards

Description

Forwards_Driver_forwards:: implements the Forwards_Driver API for ftp driven dot-forward compliant mail servers.

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

Forwards_Driver
   |
   --Forwards_Driver_forwards
Direct descendents
Class Description
 class Forwards_Driver_qmail Forwards_Driver_qmail:: implements the Forwards_Driver API for FTP driven Qmail mail servers.
Variable Summary
 VFS_ftp $_vfs
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 ()
 void _connect (string $password)
 void _createForwardsFile (string $target, [boolean $keeplocal = false])
 string _parseForwardsFile (string $content)
Variables
string $_forwardsFile = '.forward' (line 25)

The name of the forwards file.


Redefined in descendants as:
VFS_ftp $_vfs (line 32)

The FTP stream we open via the VFS class.

Inherited Variables

Inherited from Forwards_Driver

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

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

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

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

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.
  • TODO: FIXME: This function is implemented poorly, and should be rewritten.
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 143)

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.

Redefined in descendants as:
_checkConfig (line 212)

Checks if the realm has a specific configuration.

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

void _checkConfig ()
_connect (line 232)

Connects to the FTP server.

void _connect (string $password)
  • string $password: The password to connect with.
_createForwardsFile (line 66)

Creates the main forwards file.

void _createForwardsFile (string $target, [boolean $keeplocal = false])
  • 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:
_parseForwardsFile (line 200)

Parses the target information out of the forwards file content.

  • return: The forwards target.
string _parseForwardsFile (string $content)
  • string $content: The file content.

Redefined in descendants as:

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