Documentation

Ingo_Rule_System_Blacklist extends Ingo_Rule_Addresses
in package
implements Ingo_Rule_System

The blacklist rule.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2015-2017 Horde LLC

license

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

Interfaces, Classes, Traits and Enums

Ingo_Rule_System
Interface that indicates the implementing class is a system rule.

Table of Contents

DELETE_MARKER  = '++DELETE++'
String that can't be a valid folder name used to mark blacklisted email as deleted.
$addresses  : array<string|int, string>|string
$addresses  : array<string|int, string>
$addressList  : Horde_Mail_Rfc822_List
$disable  : bool
Is this rule disabled?
$mailbox  : string
$name  : string
Rule name.
$uid  : string
Unique ID of the rule.
$_addr  : Horde_Mail_Rfc822_List
Address list.
$_mbox  : string
Blacklist mailbox.
$_perm  : string
Permission name.
__construct()  : mixed
Constructor.
__get()  : mixed
__set()  : mixed
__toString()  : mixed
addAddresses()  : mixed
Add addresses to the current address list.
count()  : mixed
description()  : string
Generate the rule description.
_setAddressesException()  : Ingo_Excception

Constants

DELETE_MARKER

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

public mixed DELETE_MARKER = '++DELETE++'

Properties

$addresses write-only

public array<string|int, string>|string $addresses

A list of addresses.

$addresses read-only

public array<string|int, string> $addresses

The list of addresses.

$addressList read-only

public Horde_Mail_Rfc822_List $addressList

The list of addresses.

$disable

Is this rule disabled?

public bool $disable = \false

$mailbox

public string $mailbox

The blacklist mailbox.

$name

Rule name.

public string $name = ''

$uid

Unique ID of the rule.

public string $uid = ''

$_addr

Address list.

protected Horde_Mail_Rfc822_List $_addr

$_mbox

Blacklist mailbox.

protected string $_mbox = ''

$_perm

Permission name.

protected string $_perm = 'max_blacklist'

Methods

__construct()

Constructor.

public __construct() : mixed
Return values
mixed

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

__set()

public __set(mixed $name, mixed $data) : mixed
Parameters
$name : mixed
$data : mixed
Return values
mixed

__toString()

public __toString() : mixed
Return values
mixed

addAddresses()

Add addresses to the current address list.

public addAddresses(mixed $to_add) : mixed
Parameters
$to_add : mixed
Tags
throws
Ingo_Exception
Return values
mixed

count()

public count() : mixed
Return values
mixed

description()

Generate the rule description.

public description() : string
Return values
string

Rule description.

_setAddressesException()

protected _setAddressesException(mixed $addr_count, mixed $max) : Ingo_Excception
Parameters
$addr_count : mixed
$max : mixed
Return values
Ingo_Excception

Search results