PHP Class Ingo_Script_Procmail_Recipe, horde

Author: Ben Chavet ([email protected])

Author: Jan Schneider ([email protected])

Inheritance: implements Ingo_Script_Item

Protected Properties

Method	Description
__construct ( array $params = [], array $scriptparams = [] )	Constructs a new procmail recipe.
addCondition ( array $condition = [] )	Adds a condition to the recipe.
addFlag ( string $flag )	Adds a flag to the recipe.
generate ( ) : string	Generates procmail code to represent the recipe.
procmailPath ( string $folder ) : string	Returns a procmail-ready mailbox path, converting IMAP folder pathname conventions as necessary.

Constructs a new procmail recipe.

public __construct ( array $params = [], array $scriptparams = [] )
$params	array	Array of parameters. REQUIRED FIELDS: 'action' OPTIONAL FIELDS: 'action-value' (only used if the 'action' requires it) 'disable'
$scriptparams	array	Array of parameters passed to Ingo_Script_Procmail.

Adds a condition to the recipe.

public addCondition ( array $condition = [] )
$condition	array	Array of parameters. Required keys are 'field' and 'value'. 'case' is an optional key.

Adds a flag to the recipe.

public addFlag ( string $flag )
$flag	string	String of flags to append to the current flags.

Generates procmail code to represent the recipe.

public generate ( ) : string
return	string	Procmail code to represent the recipe.

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

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

protected $_action

protected $_conditions

protected $_disable

protected $_flags

protected $_params

protected $_valid