PHP Класс Ingo_Script_Procmail_Recipe, horde

Автор: Ben Chavet ([email protected])
Автор: Jan Schneider ([email protected])
Наследование: implements Ingo_Script_Item
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_action
$_conditions
$_disable
$_flags
$_params
$_valid

Открытые методы

Метод Описание
__construct ( array $params = [], array $scriptparams = [] ) Constructs a new procmail recipe.
addCondition ( array $condition = [] ) Adds a condition to the recipe.
addFlag ( string $flag ) Adds a flag to the recipe.
generate ( ) : string Generates procmail code to represent the recipe.
procmailPath ( string $folder ) : string Returns a procmail-ready mailbox path, converting IMAP folder pathname conventions as necessary.

Описание методов

__construct() публичный Метод

Constructs a new procmail recipe.
public __construct ( array $params = [], array $scriptparams = [] )
$params array Array of parameters. REQUIRED FIELDS: 'action' OPTIONAL FIELDS: 'action-value' (only used if the 'action' requires it) 'disable'
$scriptparams array Array of parameters passed to Ingo_Script_Procmail.

addCondition() публичный Метод

Adds a condition to the recipe.
public addCondition ( array $condition = [] )
$condition array Array of parameters. Required keys are 'field' and 'value'. 'case' is an optional key.

addFlag() публичный Метод

Adds a flag to the recipe.
public addFlag ( string $flag )
$flag string String of flags to append to the current flags.

generate() публичный Метод

Generates procmail code to represent the recipe.
public generate ( ) : string
Результат string Procmail code to represent the recipe.

procmailPath() публичный Метод

Returns a procmail-ready mailbox path, converting IMAP folder pathname conventions as necessary.
public procmailPath ( string $folder ) : string
$folder string The IMAP folder name.
Результат string The procmail mailbox path.

Описание свойств

$_action защищенное свойство

protected $_action

$_conditions защищенное свойство

protected $_conditions

$_disable защищенное свойство

protected $_disable

$_flags защищенное свойство

protected $_flags

$_params защищенное свойство

protected $_params

$_valid защищенное свойство

protected $_valid