API Documentation
\

\Ingo_Basic_Rule

Rule page.

Summary

Methods
Properties
Constants
__construct()
render()
status()
validateMbox()
url()
$output
$title
$vars
INGO_TOKEN
_addToken()
_checkToken()
_assertCategory()
_init()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

INGO_TOKEN

INGO_TOKEN

Properties

$output

$output : string

Type

string

$title

$title : string

Type

string

$vars

$vars : \Horde_Variables

Type

\Horde_Variables

Methods

__construct()

__construct(\Horde_Variables  $vars)

Parameters

\Horde_Variables $vars

render()

render()

status()

status()

validateMbox()

validateMbox(string  $name) : string

Validates an IMAP mailbox provided by user input.

Parameters

string $name

The form name of the input.

Throws

\Horde_Exception

Returns

string —

The IMAP mailbox name.

url()

url(array  $opts = array())

Parameters

array $opts

_addToken()

_addToken(\Horde_Url  $url) : \Horde_Url

Add the ingo action token to a URL.

Parameters

\Horde_Url $url

URL.

Returns

\Horde_Url —

URL with token added (for chainable calls).

_checkToken()

_checkToken(array  $actions) : string

Check token.

Parameters

array $actions

The list of actions that require token checking.

Returns

string —

The verified action ID.

_assertCategory()

_assertCategory(integer  $type, string  $label)

Assert category.

Parameters

integer $type

Category type.
string $label

Category label.

_init()

_init()