Ingo_Script_Procmail_Recipe
in package
implements
Ingo_Script_Item
The Ingo_Script_Procmail_Recipe class represents a Procmail recipe.
Tags
Interfaces, Classes, Traits and Enums
- Ingo_Script_Item
- The Ingo_Script_Item interface is an interface for individual items representing code snippets of a filter script.
Table of Contents
- $_action : mixed
- $_conditions : mixed
- $_disable : mixed
- $_flags : mixed
- $_params : mixed
- $_valid : mixed
- __construct() : mixed
- Constructs a new procmail recipe.
- addCondition() : mixed
- Adds a condition to the recipe.
- addFlag() : mixed
- Adds a flag to the recipe.
- generate() : string
- Generates procmail code to represent the recipe.
- procmailPath() : string
- Returns a procmail-ready mailbox path, converting IMAP folder pathname conventions as necessary.
Properties
$_action
protected
mixed
$_action
= array()
$_conditions
protected
mixed
$_conditions
= array()
$_disable
protected
mixed
$_disable
= ''
$_flags
protected
mixed
$_flags
= ''
$_params
protected
mixed
$_params
= array('date' => 'date', 'echo' => 'echo', 'ls' => 'ls')
$_valid
protected
mixed
$_valid
= \true
Methods
__construct()
Constructs a new procmail recipe.
public
__construct([array<string|int, mixed> $params = array() ][, array<string|int, mixed> $scriptparams = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
-
Array of parameters. REQUIRED FIELDS: 'action' OPTIONAL FIELDS: 'action-value' (only used if the 'action' requires it) 'disable'
- $scriptparams : array<string|int, mixed> = array()
-
Array of parameters passed to Ingo_Script_Procmail.
Return values
mixed —addCondition()
Adds a condition to the recipe.
public
addCondition([array<string|int, mixed> $condition = array() ]) : mixed
Parameters
- $condition : array<string|int, mixed> = array()
-
Array of parameters. Required keys are 'field' and 'value'. 'case' is an optional key.
Return values
mixed —addFlag()
Adds a flag to the recipe.
public
addFlag(string $flag) : mixed
Parameters
- $flag : string
-
String of flags to append to the current flags.
Return values
mixed —generate()
Generates procmail code to represent the recipe.
public
generate() : string
Return values
string —Procmail code to represent the recipe.
procmailPath()
Returns a procmail-ready mailbox path, converting IMAP folder pathname conventions as necessary.
public
procmailPath(string $folder) : string
Parameters
- $folder : string
-
The IMAP folder name.
Return values
string —The procmail mailbox path.