API Documentation
\

\Horde_Imap_Client_Base_Alerts

Handle IMAP alerts sent from the server.

Summary

Methods
Properties
Constants
add()
getLast()
attach()
detach()
notify()
No public properties found
No constants found
No protected methods found
$_alert
$_observers
N/A
No private methods found
No private properties found
N/A

Properties

$_alert

$_alert : object

Alert data.

Type

object

$_observers

$_observers : array

Observers.

Type

array

Methods

add()

add(string  $alert, string  $type = null)

Add an alert.

Parameters

string $alert

The alert string.
string $type

The alert type.

getLast()

getLast() : object

Returns the last alert received.

Returns

object —

Alert information. Object with these properties:

  - alert: (string) Alert string.
  - type: (string) [OPTIONAL] Alert type.

attach()

attach(\SplObserver  $observer)

Parameters

\SplObserver $observer

detach()

detach(\SplObserver  $observer)

Parameters

\SplObserver $observer

notify()

notify()

Notification is triggered internally whenever the object's internal data storage is altered.