API Documentation
\

\Ingo_Script_Procmail_Comment

The Ingo_Script_Procmail_Comment class represents a Procmail comment.

Summary

Methods
Properties
Constants
__construct()
generate()
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 : string

The comment text.

Type

string

Methods

__construct()

__construct(string  $comment, boolean  $disable = false, boolean  $header = false)

Constructs a new procmail comment.

Parameters

string $comment

Comment to be generated.
boolean $disable

Output 'DISABLED' comment?
boolean $header

Output a 'header' comment?

generate()

generate() : string

Returns the comment stored by this object.

Returns

string —

The comment stored by this object.