Class Horde_Alarm_Handler_Mail

The Horde_Alarm_Handler_Mail class is a Horde_Alarm handler that notifies of active alarms by e-mail.

Horde_Alarm_Handler

Extended by

Horde_Alarm_Handler_Mail

Package: Alarm
Author: Jan Schneider jan@horde.org
Located at Horde/Alarm/Handler/Mail.php

Methods summary
`public`	# `__construct( array $params = null )` Constructor. Constructor. Parameters `$params` <p>Any parameters that the handler might need. Required parameter: - identity: An identity factory that implements create(). - mail: A Horde_Mail_Transport instance.</p> Throws `Horde_Alarm_Exception`
`public`	# `notify( array $alarm )` Notifies about an alarm by e-mail. Notifies about an alarm by e-mail. Parameters `$alarm` An alarm hash. Throws `Horde_Alarm_Exception`
`public`	# `reset( array $alarm )` Resets the internal status of the handler, so that alarm notifications are sent again. Resets the internal status of the handler, so that alarm notifications are sent again. Parameters `$alarm` An alarm hash. Overrides `Horde_Alarm_Handler::reset()`
`public string`	# `getDescription( )` Returns a human readable description of the handler. Returns a human readable description of the handler. Returns `string`
`public array`	# `getParameters( )` Returns a hash of user-configurable parameters for the handler. Returns a hash of user-configurable parameters for the handler. 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. Returns `array` Overrides `Horde_Alarm_Handler::getParameters()`

Properties inherited from Horde_Alarm_Handler
`$alarm`