ArrayTransport
extends Transport
in package
Table of Contents
- $plugins : array<string|int, mixed>
- The plug-ins registered with the transport.
- $messages : Collection
- The collection of Swift Messages.
- __construct() : void
- Create a new array transport instance.
- flush() : Collection
- Clear all of the messages from the local collection.
- isStarted() : bool
- Test if this Transport mechanism has started.
- messages() : Collection
- Retrieve the collection of messages.
- ping() : bool
- Check if this Transport mechanism is alive.
- registerPlugin() : void
- Register a plug-in with the transport.
- send() : mixed
- {@inheritdoc}
- start() : mixed
- Start this Transport mechanism.
- stop() : mixed
- Stop this Transport mechanism.
- beforeSendPerformed() : void
- Iterate through registered plugins and execute plugins' methods.
- numberOfRecipients() : int
- Get the number of recipients.
- sendPerformed() : void
- Iterate through registered plugins and execute plugins' methods.
Properties
$plugins
The plug-ins registered with the transport.
public
array<string|int, mixed>
$plugins
= []
$messages
The collection of Swift Messages.
protected
Collection
$messages
Methods
__construct()
Create a new array transport instance.
public
__construct() : void
Return values
void —flush()
Clear all of the messages from the local collection.
public
flush() : Collection
Return values
Collection —isStarted()
Test if this Transport mechanism has started.
public
isStarted() : bool
Return values
bool —messages()
Retrieve the collection of messages.
public
messages() : Collection
Return values
Collection —ping()
Check if this Transport mechanism is alive.
public
ping() : bool
Return values
bool —TRUE if the transport is alive
registerPlugin()
Register a plug-in with the transport.
public
registerPlugin(Swift_Events_EventListener $plugin) : void
Parameters
- $plugin : Swift_Events_EventListener
Return values
void —send()
{@inheritdoc}
public
send(Swift_Mime_SimpleMessage $message[, mixed &$failedRecipients = null ]) : mixed
Parameters
- $message : Swift_Mime_SimpleMessage
- $failedRecipients : mixed = null
Return values
mixed —start()
Start this Transport mechanism.
public
start() : mixed
Return values
mixed —stop()
Stop this Transport mechanism.
public
stop() : mixed
Return values
mixed —beforeSendPerformed()
Iterate through registered plugins and execute plugins' methods.
protected
beforeSendPerformed(Swift_Mime_SimpleMessage $message) : void
Parameters
- $message : Swift_Mime_SimpleMessage
Return values
void —numberOfRecipients()
Get the number of recipients.
protected
numberOfRecipients(Swift_Mime_SimpleMessage $message) : int
Parameters
- $message : Swift_Mime_SimpleMessage
Return values
int —sendPerformed()
Iterate through registered plugins and execute plugins' methods.
protected
sendPerformed(Swift_Mime_SimpleMessage $message) : void
Parameters
- $message : Swift_Mime_SimpleMessage