Documentation

Ingo_Script_Sieve_Test_Header extends Ingo_Script_Sieve_Test
in package

The Ingo_Script_Sieve_Test_Header class represents a test on the contents of one or more headers in a message.

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

$_vars  : array<string|int, mixed>
Any necessary test parameters.
__construct()  : mixed
Constructor.
check()  : bool|string
Checks if the rule parameters are valid.
generate()  : string
Returns a script snippet representing this rule and any sub-rules.
requires()  : array<string|int, mixed>
Returns a list of sieve extensions required for this rule and any sub-rules.

Properties

$_vars

Any necessary test parameters.

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

Methods

__construct()

Constructor.

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

Any required parameters.

Return values
mixed

check()

Checks if the rule parameters are valid.

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

True if this rule is 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.

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.

Search results