API Documentation
\

\Ingo_Script_Sieve_Action

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.

Summary

Methods
Properties
Constants
requires()
check()
No public properties found
No constants found
No protected methods found
$_vars
N/A
No private methods found
No private properties found
N/A

Properties

$_vars

$_vars : array

Any necessary action parameters.

Type

array

Methods

requires()

requires() : array

Returns a list of sieve extensions required for this rule and any sub-rules.

Returns

array —

A Sieve extension list.

check()

check() : boolean|string

Checks if the rule parameters are valid.

Returns

boolean|string —

True if this rule is valid, an error message otherwise.