Class IMP_Sentmail

The abstract class that all sentmail implementations inherit from.

Direct known subclasses

IMP_Sentmail_Mongo, IMP_Sentmail_Null, IMP_Sentmail_Sql

Abstract
Package: IMP
Category: Horde
Copyright: 2010-2014 Horde LLC
License: GPL
Author: Jan Schneider jan@horde.org
Author: Michael Slusarz slusarz@horde.org
Located at Sentmail.php

Methods summary
`public`	# `__construct( array $params = array() )` Constructor. Constructor. Parameters `$params` Configuration parameters the driver needs. Throws `IMP_Exception`
`public`	# `__get( mixed $name )`
`public`	# `log( integer $action, string $message_id, string\|array $recipients, boolean $success = true )` Logs an attempt to send a message. Logs an attempt to send a message. Parameters `$action` <p>Why the message was sent (IMP_Sentmail constant).</p> `$message_id` The Message-ID. `$recipients` The list of message recipients. `$success` Whether the attempt was successful.
`public`	# `gc( )` Garbage collect log entries. Garbage collect log entries.
`abstract public array`	# `favouriteRecipients( integer $limit, mixed $filter = null )` Returns the favourite recipients. Returns the favourite recipients. Parameters `$limit` Return this number of recipients. `$filter` <p>A list of messages types that should be returned. Null returns all message types.</p> Returns `array` A list with the $limit most favourite recipients.
`abstract public integer`	# `numberOfRecipients( integer $hours, boolean $user = false )` Returns the number of recipients within a certain time period. Returns the number of recipients within a certain time period. Parameters `$hours` Time period in hours. `$user` <p>Return the number of recipients for the current user?</p> Returns `integer` The number of recipients in the given time period.

Constants summary
`string`	`NEWMSG`	# `'new'`
`string`	`REPLY`	# `'reply'`
`string`	`FORWARD`	# `'forward'`
`string`	`REDIRECT`	# `'redirect'`
`string`	`MDN`	# `'mdn'`

Magic properties summary
`public integer`	`$limit_period` If limiting recipients per time period, how many hours should this period last?
`public integer`	`$threshold` How many days should old log entries be kept?

Packages

Classes

Interfaces

Class IMP_Sentmail

Direct known subclasses

Parameters

Throws

Parameters

Parameters

Returns

Parameters

Returns