Documentation

Horde_Alarm_Handler_Mail extends Horde_Alarm_Handler
in package

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

Tags
author

Jan Schneider jan@horde.org

category

Horde

copyright

2010-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL-2.1

Table of Contents

$alarm  : mixed
The alarm object to that this handler is attached.
$_identity  : Horde_Core_Factory_Identity
An identity factory.
$_mail  : Horde_Mail_Transport
A Horde_Mail_Transport object.
__construct()  : mixed
Constructor.
getDescription()  : string
Returns a human readable description of the handler.
getParameters()  : array<string|int, mixed>
Returns a hash of user-configurable parameters for the handler.
notify()  : mixed
Notifies about an alarm by e-mail.
reset()  : mixed
Resets the internal status of the handler, so that alarm notifications are sent again.

Properties

$alarm

The alarm object to that this handler is attached.

public mixed $alarm

Horde_Alarm

$_identity

An identity factory.

protected Horde_Core_Factory_Identity $_identity

$_mail

A Horde_Mail_Transport object.

protected Horde_Mail_Transport $_mail

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $params = null ]) : mixed
Parameters
$params : array<string|int, mixed> = null

Any parameters that the handler might need. Required parameter:

  • identity: An identity factory that implements create().
  • mail: A Horde_Mail_Transport instance.
Tags
throws
Horde_Alarm_Exception
Return values
mixed

getDescription()

Returns a human readable description of the handler.

public getDescription() : string
Return values
string

getParameters()

Returns a hash of user-configurable parameters for the handler.

public getParameters() : array<string|int, mixed>

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.
Return values
array<string|int, mixed>

notify()

Notifies about an alarm by e-mail.

public notify(array<string|int, mixed> $alarm) : mixed
Parameters
$alarm : array<string|int, mixed>

An alarm hash.

Tags
throws
Horde_Alarm_Exception
Return values
mixed

reset()

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

public reset(array<string|int, mixed> $alarm) : mixed
Parameters
$alarm : array<string|int, mixed>

An alarm hash.

Return values
mixed

Search results