Class Sieve_Test

Description

The Sieve_Test class represents a Sieve Test.

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

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


	
			
Direct descendents
Class Description
 class Sieve_Test_True The Sieve_Test_True class represents a test that always evaluates to true.
 class Sieve_Test_False The Sieve_Test_False class represents a test that always evaluates to false.
 class Sieve_Test_Allof The Sieve_Test_Allof class represents a Allof test structure.
 class Sieve_Test_Anyof The Sieve_Test_Anyof class represents a Anyof test structure.
 class Sieve_Test_Relational The Sieve_Test_Relational class represents a relational test.
 class Sieve_Test_Size The Sieve_Test_Size class represents a message size test.
 class Sieve_Test_Not The Sieve_Test_Not class represents the inverse of a given test.
 class Sieve_Test_Exists The Sieve_Test_Exists class represents a test for the existsance of one or more headers in a message.
 class Sieve_Test_Address The Sieve_Test_Address class represents a test on parts or all of the addresses in the given fields.
 class Sieve_Test_Header The Sieve_Test_Header class represents a test on the contents of one or more headers in a message.
 class Sieve_Test_Body The Sieve_Test_Body class represents a test on the contents of the body in a message.
Variable Summary
 array $_vars
Method Summary
 boolean|string check ()
 array requires ()
 string toCode ()
Variables
array $_vars = array() (line 1326)

Any necessary test parameters.

Methods
check (line 1344)

Checks if the rule parameters are valid.

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

Redefined in descendants as:
requires (line 1355)

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

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

Redefined in descendants as:
toCode (line 1333)

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

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

Redefined in descendants as:

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