Swift_Transport_SpoolTransport Class Reference

Inheritance diagram for Swift_Transport_SpoolTransport:

Public Member Functions
	__construct (Swift_Events_EventDispatcher $eventDispatcher, Swift_Spool $spool=null)
	setSpool (Swift_Spool $spool)
	getSpool ()
	isStarted ()
	start ()
	stop ()
	send (Swift_Mime_Message $message, &$failedRecipients=null)
	registerPlugin (Swift_Events_EventListener $plugin)

Private Attributes
	$_spool
	$_eventDispatcher

Detailed Description

Stores Messages in a queue.

Author

Fabien Potencier

Definition at line 16 of file Transport/SpoolTransport.php.

Constructor & Destructor Documentation

__construct	(	Swift_Events_EventDispatcher	$eventDispatcher,
		Swift_Spool	$spool = null
	)

Constructor.

Definition at line 27 of file Transport/SpoolTransport.php.

Member Function Documentation

getSpool

(

)

Get the spool object.

Returns

Swift_Spool

Definition at line 52 of file Transport/SpoolTransport.php.

References $_spool.

isStarted

(

)

Tests if this Transport mechanism has started.

Returns

bool

Implements Swift_Transport.

Definition at line 62 of file Transport/SpoolTransport.php.

registerPlugin

(

Swift_Events_EventListener

$plugin

)

Register a plugin.

Parameters

Swift_Events_EventListener

$plugin

Implements Swift_Transport.

Definition at line 113 of file Transport/SpoolTransport.php.

send	(	Swift_Mime_Message	$message,
		&	$failedRecipients = null
	)

Sends the given message.

Parameters

Swift_Mime_Message	$message
	string[]	$failedRecipients An array of failures by-reference

Returns

int The number of sent e-mail's

Implements Swift_Transport.

Definition at line 89 of file Transport/SpoolTransport.php.

References Swift_Events_SendEvent\RESULT_FAILED, and Swift_Events_SendEvent\RESULT_SPOOLED.

setSpool

(

Swift_Spool

$spool

)

Sets the spool object.

Parameters

Swift_Spool

$spool

Returns

Swift_Transport_SpoolTransport

Definition at line 40 of file Transport/SpoolTransport.php.

start

(

)

Starts this Transport mechanism.

Implements Swift_Transport.

Definition at line 70 of file Transport/SpoolTransport.php.

stop

(

)

Stops this Transport mechanism.

Implements Swift_Transport.

Definition at line 77 of file Transport/SpoolTransport.php.

Member Data Documentation

$_eventDispatcher

private

The event dispatcher from the plugin API

Definition at line 22 of file Transport/SpoolTransport.php.

$_spool

private

The spool instance

Definition at line 19 of file Transport/SpoolTransport.php.

Referenced by getSpool().