Documentation

Ingo_Script_Sieve_Action_Vacation extends Ingo_Script_Sieve_Action
in package

The Ingo_Script_Sieve_Action_Vacation class represents a vacation action.

Tags
author

Mike Cochrane mike@graftonhall.co.nz

author

Jan Schneider jan@horde.org

category

Horde

license

http://www.horde.org/licenses/apache ASL

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.
_dateCheck()  : string
Uses 'date' and 'relative' extensions to limit vacation messages by date.
_dayCheck()  : mixed
_monthCheck()  : mixed
_regexCheck()  : string
Uses regular expression parsing to limit vacation messages by date.
_vacationCode()  : mixed
_yearCheck()  : mixed

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()

Any required parameters.

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.

_dateCheck()

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

protected _dateCheck() : string
Return values
string —

A Sieve script snippet.

_dayCheck()

protected _dayCheck(mixed $begin, mixed $end) : mixed
Parameters
$begin : mixed
$end : mixed
Return values
mixed —

_monthCheck()

protected _monthCheck(mixed $begin, mixed $end) : mixed
Parameters
$begin : mixed
$end : mixed
Return values
mixed —

_regexCheck()

Uses regular expression parsing to limit vacation messages by date.

protected _regexCheck() : string
Return values
string —

A Sieve script snippet.

_vacationCode()

protected _vacationCode() : mixed
Return values
mixed —

_yearCheck()

protected _yearCheck(mixed $begin, mixed $end) : mixed
Parameters
$begin : mixed
$end : mixed
Return values
mixed —

Search results