Class Ingo_Driver_sivtest

Description

Ingo_Driver_sivtest:: Implements the Sieve_Driver api to allow scripts to be installed and set active via the Cyrus sivtest command line utility.

$Horde: ingo/lib/Driver/sivtest.php,v 1.6.2.3 2009/01/06 15:24:35 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/) Copyright 2004-2007 Liam Hoekenga <liamr@umich.edu>

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/sivtest.php (line 22)

Ingo_Driver
   |
   --Ingo_Driver_sivtest
Variable Summary
 Net_Sieve $_sieve
Method Summary
 Ingo_Driver_sivtest Ingo_Driver_sivtest ([ $params = array()])
 string getScript ()
 mixed setScriptActive (string $script)
 void sivtestSocket ( $username,  $password,  $hostspec)
 mixed _connect ()
Variables
Net_Sieve $_sieve (line 36)

The Net_Sieve object.

boolean $_support_shares = false (line 29)

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_sivtest (line 41)

Constructor.

Ingo_Driver_sivtest Ingo_Driver_sivtest ([ $params = array()])
  • $params
getScript (line 122)

Returns the content of the currently active script.

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

Sets a script running on the backend.

  • return: True on success. Returns 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.
sivtestSocket (line 139)

Used to figure out which Sieve server the script will be run on, and then open a GSSAPI authenticated socket to said server.

void sivtestSocket ( $username,  $password,  $hostspec)
  • $username
  • $password
  • $hostspec
_connect (line 61)

Connect to the sieve server.

  • return: True on success, PEAR_Error on false.
mixed _connect ()

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:30 +0000 by phpDocumentor 1.4.3