Documentation

Ingo_Script_Sieve_Else extends Ingo_Script_Sieve_Base
in package

The Ingo_Script_Sieve_Else class represents a Sieve Else Statement.

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

$_actions  : array<string|int, mixed>
A list of Ingo_Script_Sieve_Action objects that go into the else clause.
__construct()  : mixed
Constructor.
check()  : bool|string
Checks if all sub-rules are valid.
generate()  : string
Returns a script snippet representing this rule and any sub-rules.
getActions()  : mixed
requires()  : array<string|int, mixed>
Returns a list of sieve extensions required for this rule and any sub-rules.
setActions()  : mixed

Properties

$_actions

A list of Ingo_Script_Sieve_Action objects that go into the else clause.

protected array<string|int, mixed> $_actions = array()

Methods

__construct()

Constructor.

public __construct([mixed $actions = null ]) : mixed
Parameters
$actions : mixed = null

An Ingo_Script_Sieve_Action object or a list of Ingo_Script_Sieve_Action objects.

Return values
mixed

check()

Checks if all sub-rules are valid.

public check() : bool|string
Return values
bool|string

True if all rules are valid, an error message otherwise.

generate()

Returns a script snippet representing this rule and any sub-rules.

public generate() : string
Return values
string

A Sieve script snippet.

getActions()

public getActions() : mixed
Return values
mixed

requires()

Returns a list of sieve extensions required for this rule and any sub-rules.

public requires() : array<string|int, mixed>
Return values
array<string|int, mixed>

A Sieve extension list.

setActions()

public setActions(mixed $actions) : mixed
Parameters
$actions : mixed
Return values
mixed

Search results