Ingo_Script_Sieve_Comment
extends Ingo_Script_Sieve_Base
in package
The Ingo_Script_Sieve_Comment class represents a Sieve comment.
Tags
Table of Contents
- $_comment : mixed
- __construct() : mixed
- Constructor.
- check() : bool|string
- Checks if the rule parameters are valid.
- generate() : string
- Returns a script snippet representing this rule and any sub-rules.
- requires() : array<string|int, mixed>
- Returns a list of sieve extensions required for this rule and any sub-rules.
Properties
$_comment
protected
mixed
$_comment
Methods
__construct()
Constructor.
public
__construct(string $comment) : mixed
Parameters
- $comment : string
-
The comment text.
Return values
mixed —check()
Checks if the rule parameters are valid.
public
check() : bool|string
Return values
bool|string —True if this rule is valid, an error message otherwise.
generate()
Returns a script snippet representing this rule and any sub-rules.
public
generate() : string
Return values
string —A Sieve script snippet.
requires()
Returns a list of sieve extensions required for this rule and any sub-rules.
public
requires() : array<string|int, mixed>
Return values
array<string|int, mixed> —A Sieve extension list.