Class Ingo_Script_Procmail

The Ingo_Script_Procmail:: class represents a Procmail script generator.

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

Ingo_Script

Ingo_Script_Procmail

Package: Ingo
Author: Brent J. Nordquist bjn@horde.org
Author: Ben Chavet ben@horde.org
Located at Script/Procmail.php

Methods summary
`public`	# `__construct( array $params = array() )` Constructor. Constructor. Parameters `$params` A hash containing parameters needed. Overrides `Ingo_Script::__construct()`
`public string`	# `toCode( )` Returns a script previously generated with generate(). Returns a script previously generated with generate(). Returns `string` The procmail script. Overrides `Ingo_Script::toCode()`
`public string`	# `generate( )` Generates the procmail script to do the filtering specified in the rules. Generates the procmail script to do the filtering specified in the rules. Returns `string` The procmail script. Overrides `Ingo_Script::generate()`
`public`	# `generateBlacklist( boolean $disable = false )` Generates the procmail script to handle the blacklist specified in the rules. Generates the procmail script to handle the blacklist specified in the rules. Parameters `$disable` Disable the blacklist?
`public`	# `generateWhitelist( boolean $disable = false )` Generates the procmail script to handle the whitelist specified in the rules. Generates the procmail script to handle the whitelist specified in the rules. Parameters `$disable` Disable the whitelist?
`public`	# `generateVacation( boolean $disable = false )` Generates the procmail script to handle vacation. Generates the procmail script to handle vacation. Parameters `$disable` Disable vacation?
`public`	# `generateForward( boolean $disable = false )` Generates the procmail script to handle mail forwards. Generates the procmail script to handle mail forwards. Parameters `$disable` Disable forwarding?
`public array`	# `additionalScripts( )` Returns any additional scripts that need to be sent to the transport layer. Returns any additional scripts that need to be sent to the transport layer. Returns `array` A list of scripts with script names as keys and script code as values. Overrides `Ingo_Script::additionalScripts()`
`public`	# `addItem( object $item )` Adds an item to the recipe list. Adds an item to the recipe list. Parameters `$item` <p>The item to add to the recipe list. The object should have a generate() function.</p>

Methods inherited from Ingo_Script
`apply(), availableActions(), availableCategories(), availableTests(), availableTypes(), canApply(), caseSensitive(), excludeRegexp(), factory(), generateAvailable(), imapFlags(), perform(), performAvailable(), specialTypes(), stopScript()`

Constants inherited from Ingo_Script
`FILTER_SEEN, FILTER_UNSEEN`

Packages

Classes

Class Ingo_Script_Procmail

Parameters

Overrides

Returns

Overrides

Returns

Overrides

Parameters

Parameters

Parameters

Parameters

Returns

Overrides

Parameters