API Documentation
\

\Ingo_Rule_System_Blacklist

The blacklist rule.

Summary

Methods
Properties
Constants
__construct()
__get()
__set()
addAddresses()
count()
__toString()
description()
$disable
$name
$uid
$mailbox
$addresses
$addresses
DELETE_MARKER
_setAddressesException()
$_addr
$_perm
$_mbox
N/A
No private methods found
No private properties found
N/A

Constants

DELETE_MARKER

DELETE_MARKER

String that can't be a valid folder name used to mark blacklisted email as deleted.

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

$mailbox

$mailbox : string

The blacklist mailbox.

Type

string

$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

$_mbox

$_mbox : string

Blacklist mailbox.

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.

_setAddressesException()

_setAddressesException(  $addr_count,   $max) : \Ingo_Excception

Parameters

$addr_count
$max

Returns

\Ingo_Excception