PHP Class IMP_Sentmail, horde

Author: Jan Schneider ([email protected])

Author: Michael Slusarz ([email protected])

Protected Properties

Свойство	Type	Description
$_params	array	Hash containing configuration parameters.

Méthode	Description
__construct ( array $params = [] )	Constructor.
__get ( $name )
favouriteRecipients ( integer $limit, mixed $filter = null ) : array	Returns the favourite recipients.
gc ( )	Garbage collect log entries.
log ( integer $action, string $message_id, string \| array $recipients, boolean $success = true )	Logs an attempt to send a message.
numberOfRecipients ( integer $hours, boolean $user = false ) : integer	Returns the number of recipients within a certain time period.

Méthode	Description
_deleteOldEntries ( integer $before )	Deletes all log entries older than a certain date.
_log ( integer $action, string $message_id, string $recipient, boolean $success )	Logs an attempt to send a message per recipient.

Constructor.

public __construct ( array $params = [] )
$params	array	Configuration parameters the driver needs.

public __get ( $name )

Deletes all log entries older than a certain date.

abstract protected _deleteOldEntries ( integer $before )
$before	integer	Unix timestamp before that all log entries should be deleted.

Logs an attempt to send a message per recipient.

abstract protected _log ( integer $action, string $message_id, string $recipient, boolean $success )
$action	integer	Why the message was sent (IMP_Sentmail constant).
$message_id	string	The Message-ID.
$recipient	string	A message recipient.
$success	boolean	Whether the attempt was successful.

Returns the favourite recipients.

abstract public favouriteRecipients ( integer $limit, mixed $filter = null ) : array
$limit	integer	Return this number of recipients.
$filter	mixed	A list of messages types that should be returned. Null returns all message types.
Résultat	array	A list with the $limit most favourite recipients.

Garbage collect log entries.

public gc ( )

Logs an attempt to send a message.

public log ( integer $action, string $message_id, string \| array $recipients, boolean $success = true )
$action	integer	Why the message was sent (IMP_Sentmail constant).
$message_id	string	The Message-ID.
$recipients	string \| array	The list of message recipients.
$success	boolean	Whether the attempt was successful.

Returns the number of recipients within a certain time period.

abstract public numberOfRecipients ( integer $hours, boolean $user = false ) : integer
$hours	integer	Time period in hours.
$user	boolean	Return the number of recipients for the current user?
Résultat	integer	The number of recipients in the given time period.

Hash containing configuration parameters.

protected array $_params
Résultat	array