API Documentation
\

\Ingo_Script_Sieve_Action_Addflag

The Ingo_Script_Sieve_Action_Addflag class represents an add flag action.

It supports both imap4flags (RFC 5232) and the older, deprecated imapflags (draft-melnikov-sieve-imapflags-03) capabilities.

Summary

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

Properties

$_vars

$_vars : array

Any necessary action parameters.

Type

array

Methods

__construct()

__construct(  $vars = array())

Constructor.

Parameters

$vars

check()

check() : boolean|string

Checks if the rule parameters are valid.

Returns

boolean|string —

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

requires()

requires() : array

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

Returns

array —

A Sieve extension list.

generate()

generate() : string

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

Returns

string —

A Sieve script snippet.

_generate()

_generate(string  $mode) : string

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

Parameters

string $mode

The sieve flag command to use. Either:

  • addflag
  • removeflag

Returns

string —

A Sieve script snippet.