Stores Messages in a queue.

package Swift
author Fabien Potencier

 Methods

Create a new SpoolTransport.

__construct(\Swift_Spool $spool) 

Parameters

$spool

\Swift_Spool

Get the spool object.

getSpool() : \Swift_Spool
Inherited
inherited_from \Swift_Transport_SpoolTransport::getSpool()

Returns

Tests if this Transport mechanism has started.

isStarted() : boolean
Inherited
inherited_from \Swift_Transport_SpoolTransport::isStarted()

Returns

boolean

Create a new SpoolTransport instance.

newInstance(\Swift_Spool $spool) : \Swift_SpoolTransport
Static

Parameters

$spool

\Swift_Spool

Returns

Register a plugin.

registerPlugin(\Swift_Events_EventListener $plugin) 
Inherited
inherited_from \Swift_Transport_SpoolTransport::registerPlugin()

Parameters

Sends the given message.

send(\Swift_Mime_Message $message, string[] $failedRecipients) : int
Inherited

Recipient/sender data will be retrieved from the Message API. The return value is the number of recipients who were accepted for delivery.

inherited_from \Swift_Transport_SpoolTransport::send()

Parameters

$failedRecipients

string[]

&$failedRecipients to collect failures by-reference

Returns

intThe number of sent emails

Sets the spool object.

setSpool(\Swift_Spool $spool) : \Swift_Transport_SpoolTransport
Inherited
inherited_from \Swift_Transport_SpoolTransport::setSpool()

Parameters

$spool

\Swift_Spool

Returns

Starts this Transport mechanism.

start() 
Inherited
inherited_from \Swift_Transport_SpoolTransport::start()

Stops this Transport mechanism.

stop() 
Inherited
inherited_from \Swift_Transport_SpoolTransport::stop()

 Properties

 

$_eventDispatcher 
Inherited
inherited_from \Swift_Transport_SpoolTransport::$$_eventDispatcher
 

$_spool 
Inherited
inherited_from \Swift_Transport_SpoolTransport::$$_spool