\Ingo_Script_Procmail_Recipe

The Ingo_Script_Procmail_Recipe class represents a Procmail recipe.

Summary

Methods

Properties

Constants

__construct()
addFlag()
addCondition()
generate()
procmailPath()

No public properties found

No constants found

No protected methods found

$_action
$_conditions
$_disable
$_flags
$_params
$_valid

N/A

No private methods found

No private properties found

N/A

File: Script/Procmail/Recipe.php
Package: Ingo
Class hierarchy: \Ingo_Script_Procmail_Recipe
Implements: \Ingo_Script_Item

$_conditions

$_conditions :

Type

$_disable

$_disable :

Type

$_flags

$_flags :

Type

$_params

$_params :

Type

$_valid

$_valid :

Type

Methods

__construct()

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

Constructs a new procmail recipe.

Parameters

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

addFlag()

addFlag(string  $flag)

Adds a flag to the recipe.

Parameters

string

$flag

String of flags to append to the current flags.

addCondition()

addCondition(array  $condition = array())

Adds a condition to the recipe.

Parameters

array

$condition

Array of parameters. Required keys are 'field' and 'value'. 'case' is an optional key.

generate()

generate() : string

Generates procmail code to represent the recipe.

Returns

string —

Procmail code to represent the recipe.

procmailPath()

procmailPath(string  $folder) : string

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

Parameters

string

$folder

The IMAP folder name.

Returns

string —

The procmail mailbox path.