Class Sieve_Action

Description

The Sieve_Action class represents an action in a Sieve script.

An action is anything that has a side effect eg: discard, redirect.

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


	
			
Direct descendents
Class Description
 class Sieve_Action_Redirect The Sieve_Action_Redirect class represents a redirect action.
 class Sieve_Action_Reject The Sieve_Action_Reject class represents a reject action.
 class Sieve_Action_Keep The Sieve_Action_Keep class represents a keep action.
 class Sieve_Action_Discard The Sieve_Action_Discard class represents a discard action.
 class Sieve_Action_Stop The Sieve_Action_Stop class represents a stop action.
 class Sieve_Action_Fileinto The Sieve_Action_Fileinto class represents a fileinto action.
 class Sieve_Action_Vacation The Sieve_Action_Vacation class represents a vacation action.
 class Sieve_Action_Flag The Sieve_Action_Flag class is the base class for flag actions.
 class Sieve_Action_Notify The Sieve_Action_Notify class represents a notify action.
Variable Summary
 array $_vars
Method Summary
 boolean|string check ()
 array requires ()
 string toCode ()
 void toString ()
Variables
array $_vars = array() (line 2285)

Any necessary action parameters.

Methods
check (line 2308)

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 2319)

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 2292)

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

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

Redefined in descendants as:
toString (line 2297)
void toString ()

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