Queue
in package
Mail queue class
Tags
Table of Contents
- $messages : array<string|int, mixed>
- Messages
- $prepared : array<string|int, mixed>
- Prepared messages
- $recipients : array<string|int, mixed>
- Recipients
- __construct() : mixed
- Constructor
- addMessage() : Queue
- Add a message to the queue
- addMessages() : Queue
- Add messages to the queue
- addRecipient() : Queue
- Add a recipient to the queue
- addRecipients() : Queue
- Add recipients to the queue
- getMessages() : array<string|int, mixed>
- Get messages
- getPreparedMessages() : array<string|int, mixed>
- Get prepared messages
- getRecipients() : array<string|int, mixed>
- Get recipients
- prepare() : array<string|int, mixed>
- Prepare queue for sending messages
- setMessages() : Queue
- Set (and clear) messages in the queue
- setRecipients() : Queue
- Set (and clear) recipients in the queue
Properties
$messages
Messages
protected
array<string|int, mixed>
$messages
= []
$prepared
Prepared messages
protected
array<string|int, mixed>
$prepared
= []
$recipients
Recipients
protected
array<string|int, mixed>
$recipients
= []
Methods
__construct()
Constructor
public
__construct() : mixed
Instantiate the mail queue object
Return values
mixed —addMessage()
Add a message to the queue
public
addMessage(Message $message) : Queue
Parameters
- $message : Message
Return values
Queue —addMessages()
Add messages to the queue
public
addMessages(array<string|int, mixed> $messages) : Queue
Parameters
- $messages : array<string|int, mixed>
Return values
Queue —addRecipient()
Add a recipient to the queue
public
addRecipient(array<string|int, mixed> $recipient) : Queue
$recipient = [ 'email' => 'me@domain.com', // Required 'name' => 'My Name', // Everything else is optional for individual message customization 'company' => 'My Company' ]
Parameters
- $recipient : array<string|int, mixed>
Tags
Return values
Queue —addRecipients()
Add recipients to the queue
public
addRecipients(array<string|int, mixed> $recipients) : Queue
Parameters
- $recipients : array<string|int, mixed>
Return values
Queue —getMessages()
Get messages
public
getMessages() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPreparedMessages()
Get prepared messages
public
getPreparedMessages() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRecipients()
Get recipients
public
getRecipients() : array<string|int, mixed>
Return values
array<string|int, mixed> —prepare()
Prepare queue for sending messages
public
prepare() : array<string|int, mixed>
Return values
array<string|int, mixed> —setMessages()
Set (and clear) messages in the queue
public
setMessages(array<string|int, mixed> $messages) : Queue
Parameters
- $messages : array<string|int, mixed>
Return values
Queue —setRecipients()
Set (and clear) recipients in the queue
public
setRecipients(array<string|int, mixed> $recipients) : Queue
Parameters
- $recipients : array<string|int, mixed>