API Documentation
\

\Ingo_Rule_System_Vacation

The vacation rule.

Summary

Methods
Properties
Constants
__construct()
__get()
__set()
addAddresses()
count()
__toString()
description()
vacationReason()
$disable
$name
$uid
$days
$end
$ignore_list
$reason
$start
$subject
$end_day
$end_month
$end_year
$exclude
$start_day
$start_month
$start_year
$exclude
$addresses
$addresses
No constants found
_setAddressesException()
$_addr
$_perm
$_days
$_end
$_exclude
$_ignoreList
$_reason
$_start
$_subject
N/A
No private methods found
No private properties found
N/A

Properties

$disable

$disable : boolean

Is this rule disabled?

Type

boolean

$name

$name : string

Rule name.

Type

string

$uid

$uid : string

Unique ID of the rule.

Type

string

$days

$days : integer

Number of vacation days.

Type

integer

$end

$end : integer

End date.

Type

integer

$ignore_list

$ignore_list : boolean

Ignore list messages?

Type

boolean

$reason

$reason : string

Vacation reason.

Type

string

$start

$start : integer

Start date.

Type

integer

$subject

$subject : string

Outgoing message subject line.

Type

string

$end_day

$end_day : integer

End date (day).

Type

integer

$end_month

$end_month : integer

End date (month).

Type

integer

$end_year

$end_year : integer

End date (year).

Type

integer

$exclude

$exclude : array

Vacation address exclusions.

Type

array

$start_day

$start_day : integer

Start date (day).

Type

integer

$start_month

$start_month : integer

Start date (month).

Type

integer

$start_year

$start_year : integer

Start date (year).

Type

integer

$exclude

$exclude : mixed

Vacation address exclusions (array or string).

Type

mixed

$addresses

$addresses : array

The list of addresses.

Type

array

$addresses

$addresses : mixed

The list of addresses (array or string).

Type

mixed

$_addr

$_addr : \Horde_Mail_Rfc822_List

Address list.

Type

\Horde_Mail_Rfc822_List

$_perm

$_perm : string

Permission name.

Type

string

$_days

$_days : integer

Number of vacation days.

Type

integer

$_end

$_end : integer

End date.

Type

integer

$_exclude

$_exclude : array

Vacation address exclusions.

Type

array

$_ignoreList

$_ignoreList : boolean

Ignore list messages?

Type

boolean

$_reason

$_reason : string

Reason.

Type

string

$_start

$_start : integer

Start date.

Type

integer

$_subject

$_subject : string

Subject of outgoing message.

Type

string

Methods

__construct()

__construct()

Constructor.

__get()

__get(  $name)

Parameters

$name

__set()

__set(  $name,   $data)

Parameters

$name
$data

addAddresses()

addAddresses(  $to_add)

Add addresses to the current address list.

Parameters

$to_add

Throws

\Ingo_Exception

count()

count()

__toString()

__toString()

description()

description() : string

Generate the rule description.

Returns

string —

Rule description.

vacationReason()

vacationReason(string  $reason, integer  $start, integer  $end) : string

Returns the vacation reason with all placeholder replaced.

Parameters

string $reason

The vacation reason including placeholders.
integer $start

The vacation start timestamp.
integer $end

The vacation end timestamp.

Returns

string —

The vacation reason suitable for usage in the filter scripts.

_setAddressesException()

_setAddressesException(  $addr_count,   $max) : \Ingo_Excception

Parameters

$addr_count
$max

Returns

\Ingo_Excception