Class Procmail_Recipe

Description

The Procmail_Recipe:: class represents a Procmail recipe.

Located in /lib/Script/procmail.php (line 381)


	
			
Variable Summary
 mixed $_action
 mixed $_conditions
 mixed $_disable
 mixed $_flags
 mixed $_params
 mixed $_valid
Method Summary
 Procmail_Recipe Procmail_Recipe ([array $params = array()], [array $scriptparams = array()])
 void addCondition ([array $condition = array()])
 void addFlag (string $flag)
 string generate ()
 string procmailPath (string $folder)
Variables
mixed $_action = array() (line 383)
mixed $_conditions = array() (line 384)
mixed $_disable = '' (line 385)
mixed $_flags = '' (line 386)
mixed $_params = array(
'date' => 'date',
'echo' => 'echo',
'ls' => 'ls'
)
(line 387)
mixed $_valid = true (line 392)
Methods
Constructor Procmail_Recipe (line 406)

Constructs a new procmail recipe.

Procmail_Recipe Procmail_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_procmail::.
addCondition (line 621)

Adds a condition to the recipe.

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

Adds a flag to the recipe.

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

Generates procmail code to represent the recipe.

  • return: Procmail code to represent the recipe.
string generate ()
procmailPath (line 748)

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

  • return: The procmail mailbox path.
string procmailPath (string $folder)
  • string $folder: The IMAP folder name.

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