Class Maildrop_Recipe

Description

The Maildrop_Recipe:: class represents a maildrop recipe.

Located in /lib/Script/maildrop.php (line 392)


	
			
Variable Summary
 mixed $_action
 mixed $_combine
 mixed $_conditions
 mixed $_disable
 mixed $_flags
 mixed $_operators
 mixed $_params
 mixed $_valid
Method Summary
 Maildrop_Recipe Maildrop_Recipe ([array $params = array()], [array $scriptparams = array()])
 void addCondition ([optonal $condition = array()])
 void addFlag (string $flag)
 string generate ()
 string maildropPath (string $folder)
Variables
mixed $_action = array() (line 394)
mixed $_combine = '' (line 399)
mixed $_conditions = array() (line 395)
mixed $_disable = '' (line 396)
mixed $_flags = '' (line 397)
mixed $_operators = array(
'less than' => '<',
'less than or equal to' => '<=',
'equal' => '==',
'not equal' => '!=',
'greater than' => '>',
'greater than or equal to' => '>=',
)
(line 402)
mixed $_params = array() (line 398)
mixed $_valid = true (line 400)
Methods
Constructor Maildrop_Recipe (line 423)

Constructs a new maildrop recipe.

Maildrop_Recipe Maildrop_Recipe ([array $params = array()], [array $scriptparams = array()])
  • array $params: Array of parameters. REQUIRED FIELDS: 'action' OPTIONAL FIELDS: 'action-value' (only used if the 'action' requires it)
  • array $scriptparams: Array of parameters passed to Ingo_Script_maildrop::.
addCondition (line 579)

Adds a condition to the recipe.

void addCondition ([optonal $condition = array()])
  • optonal $condition: array $condition Array of parameters. Required keys are 'field' and 'value'. 'case' is an optional keys.
addFlag (line 567)

Adds a flag to the recipe.

void addFlag (string $flag)
  • string $flag: String of flags to append to the current flags.
generate (line 663)

Generates maildrop code to represent the recipe.

  • return: maildrop code to represent the recipe.
string generate ()
maildropPath (line 709)

Returns a maildrop-ready mailbox path, converting IMAP folder pathname conventions as necessary.

  • return: The maildrop mailbox path.
string maildropPath (string $folder)
  • string $folder: The IMAP folder name.

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