Ingo_Rule_User_FlagOnly
extends Ingo_Rule_User
in package
User-defined flag only rule.
Tags
Table of Contents
- COMBINE_ALL = 1
- COMBINE_ANY = 2
- FLAG_ANSWERED = 1
- FLAG_AVAILABLE = 16
- FLAG_DELETED = 2
- FLAG_FLAGGED = 4
- FLAG_SEEN = 8
- TEST_BODY = 3
- TEST_HEADER = 1
- TEST_SIZE = 2
- TYPE_EMPTY = 3
- TYPE_MAILBOX = 2
- TYPE_TEXT = 1
- $combine : mixed
- $conditions : mixed
- $disable : bool
- Is this rule disabled?
- $flags : mixed
- $has_flags : bool
- $label : mixed
- $name : string
- Rule name.
- $stop : mixed
- $type : mixed
- $uid : string
- Unique ID of the rule.
- $value : mixed
- __construct() : mixed
- Constructor.
- __get() : mixed
- __toString() : mixed
- description() : string
- Generate the rule description.
- getTestInfo() : object
- Returns information on a given test string.
Constants
COMBINE_ALL
public
mixed
COMBINE_ALL
= 1
COMBINE_ANY
public
mixed
COMBINE_ANY
= 2
FLAG_ANSWERED
public
mixed
FLAG_ANSWERED
= 1
FLAG_AVAILABLE
public
mixed
FLAG_AVAILABLE
= 16
FLAG_DELETED
public
mixed
FLAG_DELETED
= 2
FLAG_FLAGGED
public
mixed
FLAG_FLAGGED
= 4
FLAG_SEEN
public
mixed
FLAG_SEEN
= 8
TEST_BODY
public
mixed
TEST_BODY
= 3
TEST_HEADER
public
mixed
TEST_HEADER
= 1
TEST_SIZE
public
mixed
TEST_SIZE
= 2
TYPE_EMPTY
public
mixed
TYPE_EMPTY
= 3
TYPE_MAILBOX
public
mixed
TYPE_MAILBOX
= 2
TYPE_TEXT
public
mixed
TYPE_TEXT
= 1
Properties
$combine
public
mixed
$combine
= self::COMBINE_ALL
$conditions
public
mixed
$conditions
= array()
$disable
Is this rule disabled?
public
bool
$disable
= \false
$flags
public
mixed
$flags
= 0
$has_flags read-only
public
bool
$has_flags
True if the rule has any flags set.
$label
public
mixed
$label
= ''
$name
Rule name.
public
string
$name
= ''
$stop
public
mixed
$stop
= \true
$type
public
mixed
$type
= 0
$uid
Unique ID of the rule.
public
string
$uid
= ''
$value
public
mixed
$value
= ''
Methods
__construct()
Constructor.
public
__construct() : mixed
Return values
mixed —__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —__toString()
public
__toString() : mixed
Return values
mixed —description()
Generate the rule description.
public
description() : string
Return values
string —Rule description.
getTestInfo()
Returns information on a given test string.
public
getTestInfo(mixed $test) : object
Parameters
- $test : mixed
Tags
Return values
object —Object with the following values:
- label: (string) The label for this action.
- type: (string) Either 'int', 'none', or 'text'.