API Documentation
\

\Ingo_Script_Sieve_Comment

The Ingo_Script_Sieve_Comment class represents a Sieve comment.

Summary

Methods
Properties
Constants
requires()
__construct()
generate()
check()
No public properties found
No constants found
No protected methods found
$_comment
N/A
No private methods found
No private properties found
N/A

Properties

$_comment

$_comment :

Type

Methods

requires()

requires() : array

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

Returns

array —

A Sieve extension list.

__construct()

__construct(string  $comment)

Constructor.

Parameters

string $comment

The comment text.

generate()

generate() : string

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

Returns

string —

A Sieve script snippet.

check()

check() : boolean|string

Checks if the rule parameters are valid.

Returns

boolean|string —

True if this rule is valid, an error message otherwise.