\Pop\MailQueue

Mail queue class

Summary

Methods
Properties
Constants
__construct()
setRecipients()
addRecipients()
addRecipient()
setMessages()
addMessages()
addMessage()
getMessages()
getRecipients()
getPreparedMessages()
prepare()
No public properties found
No constants found
No protected methods found
$recipients
$messages
$prepared
N/A
No private methods found
No private properties found
N/A

Properties

$recipients

$recipients : array

Recipients

Type

array

$messages

$messages : array

Messages

Type

array

$prepared

$prepared : array

Prepared messages

Type

array

Methods

__construct()

__construct() 

Constructor

Instantiate the mail queue object

setRecipients()

setRecipients(array  $recipients) : \Pop\Mail\Queue

Set (and clear) recipients in the queue

Parameters

array $recipients

Returns

\Pop\Mail\Queue

addRecipients()

addRecipients(array  $recipients) : \Pop\Mail\Queue

Add recipients to the queue

Parameters

array $recipients

Returns

\Pop\Mail\Queue

addRecipient()

addRecipient(array  $recipient) : \Pop\Mail\Queue

Add a recipient to the queue

$recipient = [ 'email' => 'me@domain.com', // Required 'name' => 'My Name', // Everything else is optional for individual message customization 'company' => 'My Company' ]

Parameters

array $recipient

Throws

\Pop\Mail\Exception

Returns

\Pop\Mail\Queue

setMessages()

setMessages(array  $messages) : \Pop\Mail\Queue

Set (and clear) messages in the queue

Parameters

array $messages

Returns

\Pop\Mail\Queue

addMessages()

addMessages(array  $messages) : \Pop\Mail\Queue

Add messages to the queue

Parameters

array $messages

Returns

\Pop\Mail\Queue

addMessage()

addMessage(\Pop\Mail\Message  $message) : \Pop\Mail\Queue

Add a message to the queue

Parameters

\Pop\Mail\Message $message

Returns

\Pop\Mail\Queue

getMessages()

getMessages() : array

Get messages

Returns

array

getRecipients()

getRecipients() : array

Get recipients

Returns

array

getPreparedMessages()

getPreparedMessages() : array

Get prepared messages

Returns

array

prepare()

prepare() : array

Prepare queue for sending messages

Returns

array