Ingo_Script_Maildrop_Recipe
in package
implements
Ingo_Script_Item
The Ingo_Script_Maildrop_Recipe class represents a Maildrop 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
- $_combine : mixed
- $_conditions : mixed
- $_disable : mixed
- $_flags : mixed
- $_operators : mixed
- $_params : mixed
- $_valid : mixed
- __construct() : mixed
- Constructs a new maildrop recipe.
- addCondition() : mixed
- Adds a condition to the recipe.
- addFlag() : mixed
- Adds a flag to the recipe.
- generate() : string
- Generates maildrop code to represent the recipe.
- maildropPath() : string
- Returns a maildrop-ready mailbox path, converting IMAP folder pathname conventions as necessary.
Properties
$_action
protected
mixed
$_action
= array()
$_combine
protected
mixed
$_combine
= ''
$_conditions
protected
mixed
$_conditions
= array()
$_disable
protected
mixed
$_disable
= ''
$_flags
protected
mixed
$_flags
= ''
$_operators
protected
mixed
$_operators
= array('less than' => '<', 'less than or equal to' => '<=', 'equal' => '==', 'not equal' => '!=', 'greater than' => '>', 'greater than or equal to' => '>=')
$_params
protected
mixed
$_params
= array()
$_valid
protected
mixed
$_valid
= \true
Methods
__construct()
Constructs a new maildrop 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) 'combine' 'disable'
- $scriptparams : array<string|int, mixed> = array()
-
Array of parameters passed to Ingo_Script_Maildrop::.
Return values
mixed —addCondition()
Adds a condition to the recipe.
public
addCondition([mixed $condition = array() ]) : mixed
Parameters
- $condition : mixed = array()
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 maildrop code to represent the recipe.
public
generate() : string
Return values
string —maildrop code to represent the recipe.
maildropPath()
Returns a maildrop-ready mailbox path, converting IMAP folder pathname conventions as necessary.
public
maildropPath(string $folder) : string
Parameters
- $folder : string
-
The IMAP folder name.
Return values
string —The maildrop mailbox path.