Class Ingo_Script_Procmail_Recipe
The Ingo_Script_Procmail_Recipe:: class represents a Procmail recipe.
Copyright 2003-2012 Horde LLC (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/apache.
Methods summary
public
|
#
__construct( array $params = array(), array $scriptparams = array() )
Constructs a new procmail recipe.
Constructs a new procmail recipe.
Parameters
- $params
- <p>Array of parameters.
REQUIRED FIELDS:
'action'
OPTIONAL FIELDS:
'action-value' (only used if the
'action' requires it)</p>
- $scriptparams
- <p>Array of parameters passed to
Ingo_Script_Procmail::.</p>
|
public
|
#
addFlag( string $flag )
Adds a flag to the recipe.
Adds a flag to the recipe.
Parameters
- $flag
- String of flags to append to the current flags.
|
public
|
#
addCondition( array $condition = array() )
Adds a condition to the recipe.
Adds a condition to the recipe.
Parameters
- $condition
- <p>Array of parameters. Required keys are 'field'
and 'value'. 'case' is an optional key.</p>
|
public
string
|
#
generate( )
Generates procmail code to represent the recipe.
Generates procmail code to represent the recipe.
Returns
string Procmail code to represent the recipe.
|
public
string
|
#
procmailPath( string $folder )
Returns a procmail-ready mailbox path, converting IMAP folder
pathname conventions as necessary.
Returns a procmail-ready mailbox path, converting IMAP folder
pathname conventions as necessary.
Parameters
- $folder
- The IMAP folder name.
Returns
string The procmail mailbox path.
|