PHP Class Swift_MemorySpool, Halite

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

Protected Properties

Property Type Description
$messages

Public Methods

Method Description
flushQueue ( Swift_Transport $transport, string[] &$failedRecipients = null ) : integer Sends messages using the given transport instance.
isStarted ( ) : boolean Tests if this Transport mechanism has started.
queueMessage ( Swift_Mime_Message $message ) : boolean Stores a message in the queue.
setFlushRetries ( integer $retries )
start ( ) Starts this Transport mechanism.
stop ( ) Stops this Transport mechanism.

Method Details

flushQueue() public method

Sends messages using the given transport instance.
public flushQueue ( Swift_Transport $transport, string[] &$failedRecipients = null ) : integer
$transport Swift_Transport A transport instance
$failedRecipients string[] An array of failures by-reference
return integer The number of sent emails

isStarted() public method

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

queueMessage() public method

Stores a message in the queue.
public queueMessage ( Swift_Mime_Message $message ) : boolean
$message Swift_Mime_Message The message to store
return boolean Whether the operation has succeeded

setFlushRetries() public method

public setFlushRetries ( integer $retries )
$retries integer

start() public method

Starts this Transport mechanism.
public start ( )

stop() public method

Stops this Transport mechanism.
public stop ( )

Property Details

$messages protected property

protected $messages