The Ingo_Script_procmail:: class represents a Procmail script generator.

$Horde: ingo/lib/Script/procmail.php,v 1.46.10.36 2010/08/07 13:35:44 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file LICENSE for license information (ASL). If you did not receive this file, see http://www.horde.org/licenses/asl.php.

• author: Brent J. Nordquist <bjn@horde.org>
• author: Ben Chavet <ben@horde.org>

Located in /lib/Script/procmail.php (line 16)

Ingo_Script
   |
   --Ingo_Script_procmail

array $_actions = array(
INGO_STORAGE_ACTION_KEEP,
INGO_STORAGE_ACTION_MOVE,
INGO_STORAGE_ACTION_DISCARD,
INGO_STORAGE_ACTION_REDIRECT,
INGO_STORAGE_ACTION_REDIRECTKEEP,
INGO_STORAGE_ACTION_REJECT
) (line 23)

The list of actions allowed (implemented) for this driver.

---

Redefinition of:

Ingo_Script::$_actions

The list of actions allowed (implemented) for this driver.

boolean $_casesensitive = true (line 83)

Can tests be case sensitive?

---

Redefinition of:

Ingo_Script::$_casesensitive

Can tests be case sensitive?

array $_categories = array(
INGO_STORAGE_ACTION_BLACKLIST,
INGO_STORAGE_ACTION_WHITELIST,
INGO_STORAGE_ACTION_VACATION,
INGO_STORAGE_ACTION_FORWARD
) (line 37)

The categories of filtering allowed.

---

Redefinition of:

Ingo_Script::$_categories

The categories of filtering allowed.

array $_recipes = array() (line 104)

The recipes that make up the code.

boolean $_scriptfile = true (line 97)

Does the driver require a script file to be generated?

---

Redefinition of:

Ingo_Script::$_scriptfile

Does the driver require a script file to be generated?

array $_special_types = array(
'Destination',
) (line 59)

A list of any special types that this driver supports.

---

Redefinition of:

Ingo_Script::$_special_types

A list of any special types that this driver supports.

boolean $_supportStopScript = true (line 90)

Does the driver support the stop-script option?

---

Redefinition of:

Ingo_Script::$_supportStopScript

Does the driver support the stop-script option?

array $_tests = array(
'contains',
'not contain',
'begins with',
'not begins with',
'ends with',
'not ends with',
'regex'
) (line 68)

The list of tests allowed (implemented) for this driver.

---

Redefinition of:

Ingo_Script::$_tests

The list of tests allowed (implemented) for this driver.

array $_types = array(
INGO_STORAGE_TYPE_HEADER,
INGO_STORAGE_TYPE_BODY
) (line 49)

The types of tests allowed (implemented) for this driver.

---

Redefinition of:

Ingo_Script::$_types

The types of tests allowed (implemented) for this driver.

Inherited Variables

Inherited from Ingo_Script

Ingo_Script::$_ondemand
Ingo_Script::$_params
Ingo_Script::$_supportIMAPFlags

addItem (line 316)

Adds an item to the recipe list.

void addItem (object $item)

• object $item: The item to add to the recipe list. The object should have a generate() function.

generate (line 136)

Generates the procmail script to do the filtering specified in the rules.

• return: The procmail script.

string generate ()

---

Redefinition of:

Ingo_Script::generate()

Generates the script to do the filtering specified in the rules.

generateBlacklist (line 210)

Generates the procmail script to handle the blacklist specified in the rules.

void generateBlacklist ([boolean $disable = false])

• boolean $disable: Disable the blacklist?

generateForward (line 292)

Generates the procmail script to handle mail forwards.

void generateForward ([boolean $disable = false])

• boolean $disable: Disable forwarding?

generateVacation (line 262)

Generates the procmail script to handle vacation.

void generateVacation ([boolean $disable = false])

• boolean $disable: Disable vacation?

generateWhitelist (line 240)

Generates the procmail script to handle the whitelist specified in the rules.

void generateWhitelist ([boolean $disable = false])

• boolean $disable: Disable the whitelist?

toCode (line 111)

Returns a script previously generated with generate().

• return: The procmail script.

string toCode ()

---

Redefinition of:

Ingo_Script::toCode()

Returns a script previously generated with generate().

Inherited Methods

Inherited From Ingo_Script

Ingo_Script::Ingo_Script()
Ingo_Script::apply()
Ingo_Script::availableActions()
Ingo_Script::availableCategories()
Ingo_Script::availableTests()
Ingo_Script::availableTypes()
Ingo_Script::canApply()
Ingo_Script::caseSensitive()
Ingo_Script::excludeRegexp()
Ingo_Script::factory()
Ingo_Script::generate()
Ingo_Script::generateAvailable()
Ingo_Script::imapFlags()
Ingo_Script::perform()
Ingo_Script::performAvailable()
Ingo_Script::specialTypes()
Ingo_Script::stopScript()
Ingo_Script::toCode()