Class Sieve_Test_Header

Description

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

Located in /lib/Script/sieve.php (line 2014)

Sieve_Test
   |
   --Sieve_Test_Header
Method Summary
 Sieve_Test_Header Sieve_Test_Header ([array $vars = array()])
 boolean|string check ()
 array requires ()
 string toCode ()
Variables

Inherited Variables

Inherited from Sieve_Test

Sieve_Test::$_vars
Methods
Constructor Sieve_Test_Header (line 2021)

Constructor.

Sieve_Test_Header Sieve_Test_Header ([array $vars = array()])
  • array $vars: Any required parameters.
check (line 2043)

Checks if the rule parameters are valid.

  • return: True if this rule is valid, an error message otherwise.
boolean|string check ()

Redefinition of:
Sieve_Test::check()
Checks if the rule parameters are valid.
requires (line 2110)

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

  • return: A Sieve extension list.
array requires ()

Redefinition of:
Sieve_Test::requires()
Returns a list of sieve extensions required for this rule and any sub-rules.
toCode (line 2063)

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

  • return: A Sieve script snippet.
string toCode ()

Redefinition of:
Sieve_Test::toCode()
Returns a script snippet representing this rule and any sub-rules.

Inherited Methods

Inherited From Sieve_Test

 Sieve_Test::check()
 Sieve_Test::requires()
 Sieve_Test::toCode()

Documentation generated on Sun, 30 Jan 2011 05:29:30 +0000 by phpDocumentor 1.4.3