Ingo_Script_Sieve_Action_Notify
extends Ingo_Script_Sieve_Action
in package
The Ingo_Script_Sieve_Action_Notify class represents a notify action.
It supports both enotify (RFC 5435) and the older, deprecated notify (draft-martin-sieve-notify-01) capabilities.
Tags
Table of Contents
- $_vars : array<string|int, mixed>
- Any necessary action parameters.
- __construct() : mixed
- Constructor.
- check() : bool|string
- Checks if the rule parameters are valid.
- generate() : string
- Returns a script snippet representing this rule and any sub-rules.
- requires() : array<string|int, mixed>
- Returns a list of sieve extensions required for this rule and any sub-rules.
Properties
$_vars
Any necessary action parameters.
protected
array<string|int, mixed>
$_vars
= array()
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $vars = array() ]) : mixed
Parameters
- $vars : array<string|int, mixed> = array()
-
Required parameters:
- address: (string) Address.
- name: (string) Name.
- notify: (boolean) If set, use notify instead of enotify.
Return values
mixed —check()
Checks if the rule parameters are valid.
public
check() : bool|string
Return values
bool|string —True if this rule is valid, an error message otherwise.
generate()
Returns a script snippet representing this rule and any sub-rules.
public
generate() : string
Return values
string —A Sieve script snippet.
requires()
Returns a list of sieve extensions required for this rule and any sub-rules.
public
requires() : array<string|int, mixed>
Return values
array<string|int, mixed> —A Sieve extension list.