Docs For Class Sieve

Sieve_Elsif

Description

The Sieve_Elsif class represents a Sieve Elsif Statement

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

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

Variable Summary

array $_actions

Sieve_Test $_test

Method Summary

Sieve_Elsif Sieve_Elsif ([Sieve_Test $test = null])

boolean|string check ()

void getActions ()

void getTest ()

array requires ()

void setActions ( $actions)

void setTest ( $test)

string toCode ()

Variables

array $_actions = array() (line 1213)

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

Sieve_Test $_test (line 1206)

The Sieve_Test object for the if test.

Methods

Constructor Sieve_Elsif (line 1220)

Constructor.

Sieve_Elsif Sieve_Elsif ([Sieve_Test $test = null])

Sieve_Test $test: A Sieve_Test object.

check (line 1272)

Checks if all sub-rules are valid.

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

boolean|string check ()

getActions (line 1240)

void getActions ()

getTest (line 1230)

void getTest ()

requires (line 1295)

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

return: A Sieve extension list.

array requires ()

setActions (line 1245)

void setActions ( $actions)

$actions

setTest (line 1235)

void setTest ( $test)

$test

toCode (line 1255)

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

return: A Sieve script snippet.

string toCode ()

Documentation generated on Sun, 30 Jan 2011 05:29:30 +0000 by phpDocumentor 1.4.3