Class Ingo_Script_Maildrop_Recipe
The Ingo_Script_Maildrop_Recipe:: class represents a maildrop recipe.
Copyright 2005-2007 Matt Weyland mathias@weyland.ch
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 maildrop recipe.
Constructs a new maildrop 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_Maildrop::.</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( optonal $condition = array() )
Adds a condition to the recipe.
Adds a condition to the recipe.
Parameters
- $condition
- <p>$condition Array of parameters. Required keys
are 'field' and 'value'. 'case' is
an optional keys.</p>
|
public
string
|
#
generate( )
Generates maildrop code to represent the recipe.
Generates maildrop code to represent the recipe.
Returns
string maildrop code to represent the recipe.
|
public
string
|
#
maildropPath( string $folder )
Returns a maildrop-ready mailbox path, converting IMAP folder pathname
conventions as necessary.
Returns a maildrop-ready mailbox path, converting IMAP folder pathname
conventions as necessary.
Parameters
- $folder
- The IMAP folder name.
Returns
string The maildrop mailbox path.
|