PHP Interface Swift_Transport, Halite

Author: Chris Corbyn
Show file Open project: HaliteChallenge/Halite Interface Usage Examples

Public Methods

Method Description
isStarted ( ) : boolean Test if this Transport mechanism has started.
registerPlugin ( Swift_Events_EventListener $plugin ) Register a plugin in the Transport.
send ( Swift_Mime_Message $message, string[] &$failedRecipients = null ) : integer Send the given Message.
start ( ) Start this Transport mechanism.
stop ( ) Stop this Transport mechanism.

Method Details

isStarted() public method

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

registerPlugin() public method

Register a plugin in the Transport.
public registerPlugin ( Swift_Events_EventListener $plugin )
$plugin Swift_Events_EventListener

send() public method

Recipient/sender data will be retrieved from the Message API. The return value is the number of recipients who were accepted for delivery.
public send ( Swift_Mime_Message $message, string[] &$failedRecipients = null ) : integer
$message Swift_Mime_Message
$failedRecipients string[] An array of failures by-reference
return integer

start() public method

Start this Transport mechanism.
public start ( )

stop() public method

Stop this Transport mechanism.
public stop ( )