Class Ingo_Script_Sieve

The Ingo_Script_Sieve class represents a Sieve Script.

See the enclosed file LICENSE for license information (ASL). If you did not receive this file, see http://www.horde.org/licenses/apache.

Ingo_Script

Ingo_Script_Sieve

Package: Ingo
Author: Mike Cochrane mike@graftonhall.co.nz
Located at Script/Sieve.php

Methods summary
`public string`	# `toCode( )` Returns a script previously generated with generate(). Returns a script previously generated with generate(). Returns `string` The Sieve script. Overrides `Ingo_Script::toCode()`
`public static string`	# `escapeString( string $string, boolean $regexmode = false )` Escape a string according to Sieve RFC 3028 [2.4.2]. Escape a string according to Sieve RFC 3028 [2.4.2]. Parameters `$string` The string to escape. `$regexmode` <p>Is the escaped string a regex value? Defaults to no.</p> Returns `string` The escaped string.
`public boolean\|string`	# `check( )` Checks if all rules are valid. Checks if all rules are valid. Returns `boolean\|string` True if all rules are valid, an error message otherwise.
`public array`	# `requires( )` Returns a list of sieve extensions required for this rule and any sub-rules. Returns a list of sieve extensions required for this rule and any sub-rules. Returns `array` A Sieve extension list.
`public string`	# `generate( )` Generates the Sieve script to do the filtering specified in the rules. Generates the Sieve script to do the filtering specified in the rules. Returns `string` The Sieve script. Overrides `Ingo_Script::generate()`

Methods inherited from Ingo_Script
`__construct(), additionalScripts(), apply(), availableActions(), availableCategories(), availableTests(), availableTypes(), canApply(), caseSensitive(), excludeRegexp(), factory(), generateAvailable(), imapFlags(), perform(), performAvailable(), specialTypes(), stopScript()`

Constants inherited from Ingo_Script
`FILTER_SEEN, FILTER_UNSEEN`