Ingo_Script_Sieve_Action
extends Ingo_Script_Sieve_Base
in package
The Ingo_Script_Sieve_Action class represents an action in a Sieve script.
An action is anything that has a side effect eg: discard, redirect.
Tags
Table of Contents
- $_vars : array<string|int, mixed>
- Any necessary action parameters.
- check() : bool|string
- Checks if the rule parameters are valid.
- 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
check()
Checks if the rule parameters are valid.
public
abstract check() : bool|string
Return values
bool|string —True if this rule is valid, an error message otherwise.
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.