API Documentation
\

\Ingo_Transport_Sivtest

Ingo_Transport_Sivtest implements an Ingo transport driver to allow scripts to be installed and set active via the Cyrus sivtest command line utility.

Summary

Methods
Properties
Constants
__construct()
setScriptActive()
getScript()
supportShares()
quote()
sivtestSocket()
No public properties found
No constants found
_connect()
$_sieve
$_supportShares
$_params
N/A
No private methods found
No private properties found
N/A

Properties

$_sieve

$_sieve : \Horde\ManageSieve

The ManageSieve object.

Type

\Horde\ManageSieve

$_supportShares

$_supportShares : boolean

Whether this driver allows managing other users' rules.

Type

boolean

$_params

$_params : array

Congifuration parameters.

Type

array

Methods

__construct()

__construct(array  $params = array())

Constructor.

Parameters

array $params

Configuration parameters.

setScriptActive()

setScriptActive(array  $script)

Sets a script running on the backend.

Parameters

array $script

The filter script information. Passed elements:

  • 'name': (string) the script name.
  • 'recipes': (array) the filter recipe objects.
  • 'script': (string) the filter script.

Throws

\Ingo_Exception

getScript()

getScript() : string

Returns the content of the currently active script.

Throws

\Ingo_Exception
\Horde_Exception_NotFound

Returns

string —

The complete ruleset of the specified user.

supportShares()

supportShares() : boolean

Returns whether the driver supports managing other users' rules.

Returns

boolean —

True if the driver supports shares.

quote()

quote(string  $string) : string

Quotes user input if supported by the transport driver.

Parameters

string $string

A string to quote.

Returns

string —

The quoted string.

sivtestSocket()

sivtestSocket(string  $username, string  $password, string  $hostspec) : \TODO

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

Parameters

string $username

The username.
string $password

The password.
string $hostspec

The hostspec.

Throws

\Ingo_Exception

Returns

\TODO

_connect()

_connect()

Connect to the sieve server.

Throws

\Ingo_Exception;