PHP Class Horde_Alarm_Handler_Mail, horde

Author: Jan Schneider ([email protected])

Inheritance: extends Horde_Alarm_Handler

Mostrar archivo Open project: horde/horde

Protected Properties

Property	Type	Description
$_identity	Horde_Core_Factory_Identity	An identity factory.
$_mail	Horde_Mail_Transport	A Horde_Mail_Transport object.

Public Methods

Method	Description
__construct ( array $params = null )	Constructor.
getDescription ( ) : string	Returns a human readable description of the handler.
getParameters ( ) : array	Returns a hash of user-configurable parameters for the handler.
notify ( array $alarm )	Notifies about an alarm by e-mail.
reset ( array $alarm )	Resets the internal status of the handler, so that alarm notifications are sent again.

Method Details

__construct() public method

Constructor.

public __construct ( array $params = null )
$params	array	Any parameters that the handler might need. Required parameter: - identity: An identity factory that implements create(). - mail: A Horde_Mail_Transport instance.

getDescription() public method

Returns a human readable description of the handler.

public getDescription ( ) : string
return	string

getParameters() public method

The parameters are hashes with parameter names as keys and parameter information as values. The parameter information is a hash with the following keys: - type: the parameter type as a preference type. - desc: a parameter description. - required: whether this parameter is required.

public getParameters ( ) : array
return	array

notify() public method

Notifies about an alarm by e-mail.

public notify ( array $alarm )
$alarm	array	An alarm hash.

reset() public method

Resets the internal status of the handler, so that alarm notifications are sent again.

public reset ( array $alarm )
$alarm	array	An alarm hash.

Property Details

$_identity protected_oe property

An identity factory.

protected Horde_Core_Factory_Identity $_identity
return	Horde_Core_Factory_Identity

$_mail protected_oe property

A Horde_Mail_Transport object.

protected Horde_Mail_Transport $_mail
return	Horde_Mail_Transport