Class Ingo_Script_maildrop

Description

The Ingo_Script_maildrop:: class represents a maildrop script generator.

Located in /lib/Script/maildrop.php (line 26)

Ingo_Script
   |
   --Ingo_Script_maildrop
Variable Summary
 array $_actions
 boolean $_casesensitive
 array $_categories
 array $_recipes
 boolean $_scriptfile
 array $_tests
 array $_types
Method Summary
 void addItem (object $item)
 string generate ()
 void generateBlacklist ([boolean $disable = false])
 void generateForward ([boolean $disable = false])
 void generateSpamfilter ([boolean $disable = false])
 void generateVacation ([boolean $disable = false])
 void generateWhitelist ([boolean $disable = false])
 string toCode ()
Variables
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 33)

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 87)

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,
INGO_STORAGE_ACTION_SPAM,
)
(line 47)

The categories of filtering allowed.


Redefinition of:
Ingo_Script::$_categories
The categories of filtering allowed.
array $_recipes = array() (line 108)

The recipes that make up the code.

boolean $_scriptfile = true (line 101)

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?
boolean $_supportStopScript = false (line 94)

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',
'is', 'not is',
'begins with','not begins with',
'ends with', 'not ends with',
'regex',
'matches', 'not matches',
'exists', 'not exist',
'less than', 'less than or equal to',
'equal', 'not equal',
'greater than', 'greater than or equal to',
)
(line 69)

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,
)
(line 60)

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::$_special_types
Ingo_Script::$_supportIMAPFlags
Methods
addItem (line 327)

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 130)

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

  • return: The maildrop script.
string generate ()

Redefinition of:
Ingo_Script::generate()
Generates the script to do the filtering specified in the rules.
generateBlacklist (line 188)

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

void generateBlacklist ([boolean $disable = false])
  • boolean $disable: Disable the blacklist?
generateForward (line 240)

Generates the maildrop script to handle mail forwards.

void generateForward ([boolean $disable = false])
  • boolean $disable: Disable forwarding?
generateSpamfilter (line 292)

Generates the maildrop script to handle spam as identified by SpamAssassin

void generateSpamfilter ([boolean $disable = false])
  • boolean $disable: Disable the spam-filter?
generateVacation (line 264)

Generates the maildrop script to handle vacation messages.

void generateVacation ([boolean $disable = false])
  • boolean $disable: Disable forwarding?
generateWhitelist (line 218)

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

void generateWhitelist ([boolean $disable = false])
  • boolean $disable: Disable the whitelist?
toCode (line 115)

Returns a script previously generated with generate().

  • return: The maildrop 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()

Documentation generated on Sun, 30 Jan 2011 05:29:26 +0000 by phpDocumentor 1.4.3