Class Sieve_Action_Flag

Description
Description | Descendents | Vars | Methods (details)

The Sieve_Action_Flag class is the base class for flag actions.

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

Sieve_Action
   |
   --Sieve_Action_Flag
Direct descendents
Description | Descendents | Vars | Methods (details)
Class Description
class Sieve_Action_Addflag The Sieve_Action_Addflag class represents an add flag action.
class Sieve_Action_Removeflag The Sieve_Action_Removeflag class represents a remove flag action.
Method Summary
Description | Descendants | Vars | Methods (details)
Sieve_Action_Flag Sieve_Action_Flag ([ $vars = array()])
boolean|string check ()
array requires ()
string _toCode (string $mode)
Variables
Description | Descendents | Vars (details) | Methods (details)

Inherited Variables

Inherited from Sieve_Action

Sieve_Action::$_vars
Methods
Description | Descendents | Vars Methods (details)
Constructor Sieve_Action_Flag (line 2819)

Constructor.

Sieve_Action_Flag Sieve_Action_Flag ([ $vars = array()])
  • $vars
check (line 2877)

Checks if the rule parameters are valid.

  • return: True if this rule is valid, an error message otherwise.
boolean|string check ()
Redefinition of:
Sieve_Action::check()
Checks if the rule parameters are valid.
requires (line 2888)

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

  • return: A Sieve extension list.
array requires ()
Redefinition of:
Sieve_Action::requires()
Returns a list of sieve extensions required for this rule and any sub-rules.
_toCode (line 2847)

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

  • return: A Sieve script snippet.
string _toCode (string $mode)
  • string $mode: The sieve flag command to use. Either 'removeflag' or 'addflag'.

Inherited Methods

Inherited From Sieve_Action

Sieve_Action::check()
Sieve_Action::requires()
Sieve_Action::toCode()
Sieve_Action::toString()

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