• Home
  • Swift_Transport_SpoolTransport

PHP Class Swift_Transport_SpoolTransport, Halite

Author: Fabien Potencier
Inheritance: implements Swift_Transport
Show file Open project: HaliteChallenge/Halite Class Usage Examples

Public Methods

Method Description
__construct ( Swift_Events_EventDispatcher $eventDispatcher, Swift_Spool $spool = null ) Constructor.
getSpool ( ) : Swift_Spool Get the spool object.
isStarted ( ) : boolean Tests if this Transport mechanism has started.
registerPlugin ( Swift_Events_EventListener $plugin ) Register a plugin.
send ( Swift_Mime_Message $message, string[] &$failedRecipients = null ) : integer Sends the given message.
setSpool ( Swift_Spool $spool ) : Swift_Transport_SpoolTransport Sets the spool object.
start ( ) Starts this Transport mechanism.
stop ( ) Stops this Transport mechanism.

Method Details

__construct() public method

Constructor.
public __construct ( Swift_Events_EventDispatcher $eventDispatcher, Swift_Spool $spool = null )
$eventDispatcher Swift_Events_EventDispatcher
$spool Swift_Spool

getSpool() public method

Get the spool object.
public getSpool ( ) : Swift_Spool
return Swift_Spool

isStarted() public method

Tests if this Transport mechanism has started.
public isStarted ( ) : boolean
return boolean

registerPlugin() public method

Register a plugin.
public registerPlugin ( Swift_Events_EventListener $plugin )
$plugin Swift_Events_EventListener

send() public method

Sends the given message.
public send ( Swift_Mime_Message $message, string[] &$failedRecipients = null ) : integer
$message Swift_Mime_Message
$failedRecipients string[] An array of failures by-reference
return integer The number of sent e-mail's

setSpool() public method

Sets the spool object.
public setSpool ( Swift_Spool $spool ) : Swift_Transport_SpoolTransport
$spool Swift_Spool
return Swift_Transport_SpoolTransport

start() public method

Starts this Transport mechanism.
public start ( )

stop() public method

Stops this Transport mechanism.
public stop ( )