Swift_SpoolTransport
extends Swift_Transport_SpoolTransport
in package
Stores Messages in a queue.
Tags
Table of Contents
- $eventDispatcher : mixed
- The event dispatcher from the plugin API
- $spool : mixed
- The spool instance
- __construct() : mixed
- Create a new SpoolTransport.
- getSpool() : Swift_Spool
- Get the spool object.
- isStarted() : bool
- Tests if this Transport mechanism has started.
- ping() : bool
- Check if this Transport mechanism is alive.
- registerPlugin() : mixed
- Register a plugin.
- send() : int
- Sends the given message.
- setSpool() : $this
- Sets the spool object.
- start() : mixed
- Starts this Transport mechanism.
- stop() : mixed
- Stops this Transport mechanism.
Properties
$eventDispatcher
The event dispatcher from the plugin API
private
mixed
$eventDispatcher
$spool
The spool instance
private
mixed
$spool
Methods
__construct()
Create a new SpoolTransport.
public
__construct(Swift_Spool $spool) : mixed
Parameters
- $spool : Swift_Spool
Return values
mixed —getSpool()
Get the spool object.
public
getSpool() : Swift_Spool
Return values
Swift_Spool —isStarted()
Tests if this Transport mechanism has started.
public
isStarted() : bool
Return values
bool —ping()
Check if this Transport mechanism is alive.
public
ping() : bool
Return values
bool —TRUE if the transport is alive
registerPlugin()
Register a plugin.
public
registerPlugin(Swift_Events_EventListener $plugin) : mixed
Parameters
- $plugin : Swift_Events_EventListener
Return values
mixed —send()
Sends the given message.
public
send(Swift_Mime_SimpleMessage $message[, array<string|int, string> &$failedRecipients = null ]) : int
Parameters
- $message : Swift_Mime_SimpleMessage
- $failedRecipients : array<string|int, string> = null
-
An array of failures by-reference
Return values
int —The number of sent e-mail's
setSpool()
Sets the spool object.
public
setSpool(Swift_Spool $spool) : $this
Parameters
- $spool : Swift_Spool
Return values
$this —start()
Starts this Transport mechanism.
public
start() : mixed
Return values
mixed —stop()
Stops this Transport mechanism.
public
stop() : mixed