Documentation

Ingo_Transport_Timsieved extends Ingo_Transport_Base
in package

Ingo_Transport_Timsieved implements an Ingo transport driver to allow scripts to be installed and set active via a Cyrus timsieved server.

Tags
author

Mike Cochrane mike@graftonhall.co.nz

author

Jan Schneider jan@horde.org

category

Horde

license

http://www.horde.org/licenses/apache ASL

Table of Contents

$_params  : array<string|int, mixed>
Congifuration parameters.
$_sieve  : Client
The ManageSieve object.
$_supportShares  : bool
Whether this driver allows managing other users' rules.
__construct()  : mixed
Constructor.
getScript()  : string
Returns the content of the currently active script.
quote()  : string
Quotes user input if supported by the transport driver.
setScriptActive()  : mixed
Sets a script running on the backend.
supportShares()  : bool
Returns whether the driver supports managing other users' rules.
_connect()  : mixed
Connects to the sieve server.

Properties

$_params

Congifuration parameters.

protected array<string|int, mixed> $_params = array('password' => \null, 'username' => \null)

$_sieve

The ManageSieve object.

protected Client $_sieve

$_supportShares

Whether this driver allows managing other users' rules.

protected bool $_supportShares = \true

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed> = array()

Configuration parameters.

Return values
mixed

getScript()

Returns the content of the currently active script.

public getScript() : string
Tags
throws
Ingo_Exception
throws
Horde_Exception_NotFound
Return values
string

The complete ruleset of the specified user.

quote()

Quotes user input if supported by the transport driver.

public quote(string $string) : string
Parameters
$string : string

A string to quote.

Return values
string

The quoted string.

setScriptActive()

Sets a script running on the backend.

public setScriptActive(array<string|int, mixed> $script) : mixed
Parameters
$script : array<string|int, mixed>

The filter script information. Passed elements:

  • 'name': (string) the script name.
  • 'recipes': (array) the filter recipe objects.
  • 'script': (string) the filter script.
Tags
throws
Ingo_Exception
Return values
mixed

supportShares()

Returns whether the driver supports managing other users' rules.

public supportShares() : bool
Return values
bool

True if the driver supports shares.

_connect()

Connects to the sieve server.

protected _connect() : mixed
Tags
throws
Ingo_Exception
Return values
mixed

Search results