PHP Class Ingo_Script_Maildrop_Recipe, horde

Author: Matt Weyland ([email protected])
Author: Jan Schneider ([email protected])
Inheritance: implements Ingo_Script_Item
Mostra file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_action
$_combine
$_conditions
$_disable
$_flags
$_operators
$_params
$_valid

Public Methods

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

Method Details

__construct() public method

Constructs a new maildrop 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) 'combine' 'disable'
$scriptparams array Array of parameters passed to Ingo_Script_Maildrop::.

addCondition() public method

Adds a condition to the recipe.
public addCondition ( $condition = [] )

addFlag() public method

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

generate() public method

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

maildropPath() public method

Returns a maildrop-ready mailbox path, converting IMAP folder pathname conventions as necessary.
public maildropPath ( string $folder ) : string
$folder string The IMAP folder name.
return string The maildrop mailbox path.

Property Details

$_action protected_oe property

protected $_action

$_combine protected_oe property

protected $_combine

$_conditions protected_oe property

protected $_conditions

$_disable protected_oe property

protected $_disable

$_flags protected_oe property

protected $_flags

$_operators protected_oe property

protected $_operators

$_params protected_oe property

protected $_params

$_valid protected_oe property

protected $_valid