\Ingo_Script_Sieve_Test_Header

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

A test is a piece of code that evaluates to true or false.

Summary

Methods
Properties
Constants
check()
requires()
__construct()
generate()
No public properties found
No constants found
No protected methods found
$_vars
N/A
No private methods found
No private properties found
N/A

Properties

$_vars

$_vars : array

Any necessary test parameters.

Type

array

Methods

check()

check() : boolean|string

Checks if the rule parameters are valid.

Returns

boolean|string —

True if this rule is valid, an error message otherwise.

requires()

requires() : array

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

Returns

array —

A Sieve extension list.

__construct()

__construct(array  $vars = array()) 

Constructor.

Parameters

array $vars

Any required parameters.

generate()

generate() : string

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

Returns

string —

A Sieve script snippet.