Docs For Class Sieve

Description

The Sieve_If class represents a Sieve If Statement

author: Mike Cochrane <mike@graftonhall.co.nz>
since: Ingo 0.1

Located in /lib/Script/sieve.php (line 920)

Variable Summary

array $_actions

Sieve_Else $_else

array $_elsifs

Sieve_Test $_test

Method Summary

Sieve_If Sieve_If ([Sieve_Test $test = null])

void addElsif ( $elsif)

boolean|string check ()

void getActions ()

void getElse ()

void getElsifs ()

void getTest ()

array requires ()

void setActions ( $actions)

void setElse ( $else)

void setElsifs ( $elsifs)

void setTest ( $test)

string toCode ()

Variables

array $_actions = array() (line 934)

A list of Sieve_Action objects that go into the if clause.

Sieve_Else $_else (line 948)

A Sieve_Else object that creates an optional else clause.

array $_elsifs = array() (line 941)

A list of Sieve_Elseif objects that create optional elsif clauses.

Sieve_Test $_test (line 927)

The Sieve_Test object for the if test.

Methods

Constructor Sieve_If (line 955)

Constructor.

Sieve_If Sieve_If ([Sieve_Test $test = null])

Sieve_Test $test: A Sieve_Test object.

addElsif (line 997)

void addElsif ( $elsif)

$elsif

check (line 1040)

Checks if all sub-rules are valid.

return: True if all rules are valid, an error message otherwise.

boolean|string check ()

getActions (line 977)

void getActions ()

getElse (line 1002)

void getElse ()

getElsifs (line 987)

void getElsifs ()

getTest (line 967)

void getTest ()

requires (line 1075)

Returns a list of sieve extensions required for this rule and any sub-rules.

return: A Sieve extension list.

array requires ()

setActions (line 982)

void setActions ( $actions)

$actions

setElse (line 1007)

void setElse ( $else)

$else

setElsifs (line 992)

void setElsifs ( $elsifs)

$elsifs

setTest (line 972)

void setTest ( $test)

$test

toCode (line 1017)

Returns a script snippet representing this rule and any sub-rules.

return: A Sieve script snippet.

string toCode ()