\Ingo_Script_Sieve_Action_Vacation

The Ingo_Script_Sieve_Action_Vacation class represents a vacation action.

An action is anything that has a side effect eg: discard, redirect.

Summary

Methods
Properties
Constants
check()
requires()
__construct()
generate()
No public properties found
No constants found
_regexCheck()
_dateCheck()
_vacationCode()
_yearCheck()
_monthCheck()
_dayCheck()
$_vars
N/A
No private methods found
No private properties found
N/A

Properties

$_vars

$_vars : array

Any necessary action parameters.

Type

array

Methods

check()

check() : boolean|string

Checks if the rule parameters are valid.

Returns

boolean|string —

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

requires()

requires() : array

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

Returns

array —

A Sieve extension list.

__construct()

__construct(array  $vars = array()) 

Constructor.

Parameters

array $vars

Any required parameters.

generate()

generate() : string

Returns a script snippet representing this rule and any sub-rules.

Returns

string —

A Sieve script snippet.

_regexCheck()

_regexCheck() : string

Uses regular expression parsing to limit vacation messages by date.

Returns

string —

A Sieve script snippet.

_dateCheck()

_dateCheck() : string

Uses 'date' and 'relative' extensions to limit vacation messages by date.

Returns

string —

A Sieve script snippet.

_vacationCode()

_vacationCode() 

_yearCheck()

_yearCheck(  $begin,   $end) 

Parameters

$begin
$end

_monthCheck()

_monthCheck(  $begin,   $end) 

Parameters

$begin
$end

_dayCheck()

_dayCheck(  $begin,   $end) 

Parameters

$begin
$end