Documentation

Ingo
in package

Ingo base class.

Tags
author

Mike Cochrane mike@graftonhall.co.nz

author

Jan Schneider jan@horde.org

category

Horde

copyright

2002-2017 Horde LLC

license

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

Table of Contents

FILTER_SEEN  = 2
Only filter seen messages.
FILTER_UNSEEN  = 1
Only filter unseen messages.
RULE_ALL  = 0
Constants for rule types.
RULE_BLACKLIST  = 2
RULE_FILTER  = 1
RULE_FORWARD  = 5
RULE_SPAM  = 6
RULE_VACATION  = 4
RULE_WHITELIST  = 3
USER_HEADER  = '++USER_HEADER++'
Define the key to use to indicate a user-defined header is requested.
getDomain()  : string
Returns the domain name, if any of the user whose rules are currently being edited.
getInitialPage()  : Horde_Url
Return Ingo's initial page.
getUser()  : string
Returns the user whose rules are currently being edited.
hasSharePermission()  : bool
Check share permissions.
loadBackends()  : array<string|int, mixed>
Loads the backends.php configuration file.

Constants

FILTER_SEEN

Only filter seen messages.

public mixed FILTER_SEEN = 2

FILTER_UNSEEN

Only filter unseen messages.

public mixed FILTER_UNSEEN = 1

RULE_ALL

Constants for rule types.

public mixed RULE_ALL = 0

RULE_BLACKLIST

public mixed RULE_BLACKLIST = 2

RULE_FILTER

public mixed RULE_FILTER = 1

RULE_FORWARD

public mixed RULE_FORWARD = 5

RULE_SPAM

public mixed RULE_SPAM = 6

RULE_VACATION

public mixed RULE_VACATION = 4

RULE_WHITELIST

public mixed RULE_WHITELIST = 3

USER_HEADER

Define the key to use to indicate a user-defined header is requested.

public mixed USER_HEADER = '++USER_HEADER++'

Methods

getDomain()

Returns the domain name, if any of the user whose rules are currently being edited.

public static getDomain() : string
Return values
string

The current user's domain name.

getInitialPage()

Return Ingo's initial page.

public static getInitialPage() : Horde_Url
Return values
Horde_Url

URL object.

getUser()

Returns the user whose rules are currently being edited.

public static getUser([bool $full = true ]) : string
Parameters
$full : bool = true

Always return the full user name with realm?

Return values
string

The current user.

hasSharePermission()

Check share permissions.

public static hasSharePermission([mixed $mask = null ]) : bool
Parameters
$mask : mixed = null
Return values
bool

True if user has permission.

loadBackends()

Loads the backends.php configuration file.

public static loadBackends() : array<string|int, mixed>
Tags
throws
Horde_Exception
Return values
array<string|int, mixed>

Configuration data.

Search results