PHP Class Ingo_Script_Sieve_Action_Notify, horde

It supports both enotify (RFC 5435) and the older, deprecated notify (draft-martin-sieve-notify-01) capabilities.
Author: Paul Wolstenholme ([email protected])
Author: Jan Schneider ([email protected])
Inheritance: extends Ingo_Script_Sieve_Action
Datei anzeigen Open project: horde/horde

Public Methods

Method Description
__construct ( array $vars = [] ) Constructor.
check ( ) : boolean | string Checks if the rule parameters are valid.
generate ( ) : string Returns a script snippet representing this rule and any sub-rules.
requires ( ) : array Returns a list of sieve extensions required for this rule and any sub-rules.

Method Details

__construct() public method

Constructor.
public __construct ( array $vars = [] )
$vars array Required parameters: - address: (string) Address. - name: (string) Name. - notify: (boolean) If set, use notify instead of enotify.

check() public method

Checks if the rule parameters are valid.
public check ( ) : boolean | string
return boolean | string True if this rule is valid, an error message otherwise.

generate() public method

Returns a script snippet representing this rule and any sub-rules.
public generate ( ) : string
return string A Sieve script snippet.

requires() public method

Returns a list of sieve extensions required for this rule and any sub-rules.
public requires ( ) : array
return array A Sieve extension list.