Constants

COMBINE_ALL

COMBINE_ALL

COMBINE_ANY

COMBINE_ANY

FLAG_ANSWERED

FLAG_ANSWERED

FLAG_DELETED

FLAG_DELETED

FLAG_FLAGGED

FLAG_FLAGGED

FLAG_SEEN

FLAG_SEEN

FLAG_AVAILABLE

FLAG_AVAILABLE

TEST_HEADER

TEST_HEADER

TEST_SIZE

TEST_SIZE

TEST_BODY

TEST_BODY

TYPE_TEXT

TYPE_TEXT

TYPE_MAILBOX

TYPE_MAILBOX

TYPE_EMPTY

TYPE_EMPTY

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

$flags

$flags : 

Type

$label

$label : 

Type

$type

$type : 

Type

$combine

$combine : 

Type

$conditions

$conditions : 

Type

$stop

$stop : 

Type

$value

$value : 

Type

$has_flags

$has_flags : boolean

True if the rule has any flags set.

Type

boolean

Methods

__toString()

__toString() 

description()

description() : string

Output description for a rule.

Returns

string —

Text description.

__construct()

__construct() 

Constructor.

__get()

__get(  $name) 

Parameters

$name

getTestInfo()

getTestInfo(  $test) : object

Returns information on a given test string.

Parameters

$test

Returns

object —

Object with the following values:

  • label: (string) The label for this action.
  • type: (string) Either 'int', 'none', or 'text'.