API Documentation
\

\Horde_Alarm_Handler_Mail

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

Summary

Methods
Properties
Constants
notify()
reset()
getDescription()
getParameters()
__construct()
$alarm
No constants found
No protected methods found
$_identity
$_mail
N/A
No private methods found
No private properties found
N/A

Properties

$alarm

$alarm :

The alarm object to that this handler is attached.

Horde_Alarm

Type

$_identity

$_identity : \Horde_Core_Factory_Identity

An identity factory.

Type

\Horde_Core_Factory_Identity

$_mail

$_mail : \Horde_Mail_Transport

A Horde_Mail_Transport object.

Type

\Horde_Mail_Transport

Methods

notify()

notify(array  $alarm)

Notifies about an alarm by e-mail.

Parameters

array $alarm

An alarm hash.

Throws

\Horde_Alarm_Exception

reset()

reset(array  $alarm)

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

Parameters

array $alarm

An alarm hash.

getDescription()

getDescription() : string

Returns a human readable description of the handler.

Returns

string

getParameters()

getParameters() : array

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

__construct()

__construct(array  $params = null)

Constructor.

Parameters

array $params

Any parameters that the handler might need. Required parameter:

  • identity: An identity factory that implements create().
  • mail: A Horde_Mail_Transport instance.

Throws

\Horde_Alarm_Exception