Class Ingo_Driver_timsieved

Description

Ingo_Driver_timsieved:: Implements the Sieve_Driver api to allow scripts to be installed and set active via a Cyrus timsieved server.

$Horde: ingo/lib/Driver/timsieved.php,v 1.15.10.14 2010/07/06 13:53:30 jan Exp $

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

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

Located in /lib/Driver/timsieved.php (line 20)

Ingo_Driver
   |
   --Ingo_Driver_timsieved
Variable Summary
 Net_Sieve $_sieve
Method Summary
 Ingo_Driver_timsieved Ingo_Driver_timsieved ([ $params = array()])
 string getScript ()
 mixed setScriptActive (string $script)
 void _connect ()
 void _debug (Net_Sieve $sieve, string $message)
Variables
Net_Sieve $_sieve (line 34)

The Net_Sieve object.

boolean $_support_shares = true (line 27)

Whether this driver allows managing other users' rules.


Redefinition of:
Ingo_Driver::$_support_shares
Whether this driver allows managing other users' rules.

Inherited Variables

Inherited from Ingo_Driver

Ingo_Driver::$_params
Methods
Constructor Ingo_Driver_timsieved (line 39)

Constructor.

Ingo_Driver_timsieved Ingo_Driver_timsieved ([ $params = array()])
  • $params
getScript (line 135)

Returns the content of the currently active script.

  • return: The complete ruleset of the specified user.
string getScript ()
setScriptActive (line 109)

Sets a script running on the backend.

  • return: True on success, PEAR_Error on error.
mixed setScriptActive (string $script)
  • string $script: The sieve script.

Redefinition of:
Ingo_Driver::setScriptActive()
Sets a script running on the backend.
_connect (line 55)

Connects to the sieve server.

void _connect ()
_debug (line 97)

Routes the Sieve protocol log to the Horde log.

void _debug (Net_Sieve $sieve, string $message)
  • Net_Sieve $sieve: A Net_Sieve object.
  • string $message: The tracked Sieve communication.

Inherited Methods

Inherited From Ingo_Driver

 Ingo_Driver::Ingo_Driver()
 Ingo_Driver::factory()
 Ingo_Driver::setScriptActive()
 Ingo_Driver::supportShares()

Documentation generated on Sun, 30 Jan 2011 05:29:32 +0000 by phpDocumentor 1.4.3