Class Vacation_Driver_forwards

Description

Vacation_Driver_forwards:: implements the Vacation_Driver API for ftp driven dot-forward compliant mail servers.

$Horde: vacation/lib/Driver/forwards.php,v 1.43.2.6 2009/01/06 15:28:08 jan Exp $

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

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

Located in /lib/Driver/forwards.php (line 17)

Vacation_Driver
   |
   --Vacation_Driver_forwards
Direct descendents
Class Description
 class Vacation_Driver_qmail Vacation_Driver_qmail implements the Vacation_Driver API for ftp driven qmail mail servers. This depends on Peter Samuel's qmail-vacation program.
Variable Summary
 array $_details
 VFS_ftp $_vfs
Method Summary
 void setVacation (string $password, string $message, string $subject, string $from, [string $alias = ''])
 void unsetVacation (string $password)
 void _checkConfig ()
 void _connect (string $password)
 void _createVacationFile (string $alias)
 array _getUserDetails (string $password)
 mixed _parseForward (string $str)
Variables
array $_details = null (line 31)

The current vacation details.

VFS_ftp $_vfs (line 24)

The FTP stream we open via the VFS class.

Inherited Variables

Inherited from Vacation_Driver

Vacation_Driver::$capabilities
Vacation_Driver::$_from
Vacation_Driver::$_message
Vacation_Driver::$_params
Vacation_Driver::$_realm
Vacation_Driver::$_subject
Vacation_Driver::$_user
Methods
setVacation (line 42)

Sets up vacation notices for a user.

void setVacation (string $password, string $message, string $subject, string $from, [string $alias = ''])
  • string $password: The password for the user.
  • string $message: The text of the vacation notice.
  • string $subject: The subject of the vacation notice.
  • string $from: The From: address of the vacation notice.
  • string $alias: The alias email address.

Redefinition of:
Vacation_Driver::setVacation()
Sets up vacation notices for a user.
unsetVacation (line 153)

Removes any existing vacation notices.

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

Redefinition of:
Vacation_Driver::unsetVacation()
Disables vacation notices for a user.
_checkConfig (line 253)

Checks if the realm has a specific configuration. If not, tries to fall back on the default configuration. If still not a valid configuration then returns an error.

void _checkConfig ()
_connect (line 309)

Connects to the FTP server.

void _connect (string $password)
  • string $password: The password to connect with.
_createVacationFile (line 108)

Creates the main vacation file.

void _createVacationFile (string $alias)
  • string $alias: The alias email address.

Redefined in descendants as:
_deleteVacationFile (line 187)

Deletes the main vacation file.

void _deleteVacationFile ()

Redefined in descendants as:
_getUserDetails (line 204)

Retrieves the current vacation details for the user.

  • return: Vacation details or PEAR_Error on failure.
array _getUserDetails (string $password)
  • string $password: The password for user.

Redefinition of:
Vacation_Driver::_getUserDetails()
Retrieves the current vacation details for the user.

Redefined in descendants as:
_parseForward (line 275)

Parses a string from the .forward file.

  • return: The contents of the file in an array
mixed _parseForward (string $str)
  • string $str: The string from the .forward file.
_setVacationPreCheck (line 99)

Runs any code required before creating the vacation file.

  • see: Vacation_Driver_qmail::
void _setVacationPreCheck ()

Redefined in descendants as:

Inherited Methods

Inherited From Vacation_Driver

 Vacation_Driver::Vacation_Driver()
 Vacation_Driver::currentFrom()
 Vacation_Driver::currentMessage()
 Vacation_Driver::currentSubject()
 Vacation_Driver::factory()
 Vacation_Driver::getFrom()
 Vacation_Driver::getParam()
 Vacation_Driver::getUser()
 Vacation_Driver::hasCapability()
 Vacation_Driver::isEnabled()
 Vacation_Driver::setVacation()
 Vacation_Driver::unsetVacation()
 Vacation_Driver::_buildMessage()
 Vacation_Driver::_encryptPassword()
 Vacation_Driver::_getUserDetails()
 Vacation_Driver::_makeEmailAddress()
 Vacation_Driver::_parseMessage()
 Vacation_Driver::_processMessage()

Documentation generated on Sun, 30 Jan 2011 05:40:31 +0000 by phpDocumentor 1.4.3