API Documentation
\

\Ingo_Script_Maildrop_Recipe

The Ingo_Script_Maildrop_Recipe class represents a Maildrop recipe.

Summary

Methods
Properties
Constants
__construct()
addFlag()
addCondition()
generate()
maildropPath()
No public properties found
No constants found
No protected methods found
$_action
$_conditions
$_disable
$_flags
$_params
$_combine
$_valid
$_operators
N/A
No private methods found
No private properties found
N/A

Properties

$_action

$_action :

Type

$_conditions

$_conditions :

Type

$_disable

$_disable :

Type

$_flags

$_flags :

Type

$_params

$_params :

Type

$_combine

$_combine :

Type

$_valid

$_valid :

Type

$_operators

$_operators :

Type

Methods

__construct()

__construct(array  $params = array(), array  $scriptparams = array())

Constructs a new maildrop recipe.

Parameters

array $params

Array of parameters. REQUIRED FIELDS: 'action' OPTIONAL FIELDS: 'action-value' (only used if the 'action' requires it) 'combine' 'disable'
array $scriptparams

Array of parameters passed to Ingo_Script_Maildrop::.

addFlag()

addFlag(string  $flag)

Adds a flag to the recipe.

Parameters

string $flag

String of flags to append to the current flags.

addCondition()

addCondition(  $condition = array())

Adds a condition to the recipe.

Parameters

$condition

generate()

generate() : string

Generates maildrop code to represent the recipe.

Returns

string —

maildrop code to represent the recipe.

maildropPath()

maildropPath(string  $folder) : string

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

Parameters

string $folder

The IMAP folder name.

Returns

string —

The maildrop mailbox path.