SGL_Emailer_Queue
Description
Emailer queue.
Located in /SGL/Emailer/Queue.php (line 11)
Variable Summary
Method Summary
boolean
processQueue
([string $deliveryDate = null], [integer $interval = null], [array $aParams = null], [integer $skipSend = false])
boolean
push
(array $headers, mixed $recipient, string $body, [string $subject = ''], [integer $groupId = null], [integer $batchId = null], [integer $userId = null])
Variables
array
$_aOptions
= array('delay' => 60, // in seconds
'attempts' => 25, // try to send each email 25 times
'limit' => 50, // how many emails to send per request
'container' => 'db', // the only one supported for now
'removeSent' => 1 // by default we remove sent emails
) (line 18)
Default send options.
SGL_Emailer_Queue_Container
$_container
(line 31)
Container.
Methods
Constructor SGL_Emailer_Queue (line 40)
Constructor.
- array $aOptions
pop (line 81)
Pops email from queue.
object.
pop
([string $deliveryDate = null], [array $aParams = null])
- string $deliveryDate
- array $aParams
processQueue (line 113)
Processes email queue. Sends retrieved emails.
boolean
processQueue
([string $deliveryDate = null], [integer $interval = null], [array $aParams = null], [integer $skipSend = false])
- string $deliveryDate
- integer $interval
- array $aParams
- integer $skipSend
push (line 60)
Puts email to queue.
boolean
push
(array $headers, mixed $recipient, string $body, [string $subject = ''], [integer $groupId = null], [integer $batchId = null], [integer $userId = null])
- array $headers
- mixed $recipient
- string $body
- string $subject
- integer $groupId
- integer $batchId
- integer $userId
remove (line 98)
Removes email from queue.
boolean
remove
(integer $emailId)
- integer $emailId
send (line 157)
Sends emails.
boolean
send
(object $email)
- object $email
_preload (line 182)
Preloads queue.
boolean
_preload
(string $deliveryDate, array $aParams)
- string $deliveryDate
- array $aParams
Documentation generated on Tue, 23 Feb 2010 18:14:32 +0000 by phpDocumentor 1.4.3