Swift_Spool Interface Reference

Inheritance diagram for Swift_Spool:

Public Member Functions
	start ()
	stop ()
	isStarted ()
	queueMessage (Swift_Mime_Message $message)
	flushQueue (Swift_Transport $transport, &$failedRecipients=null)

Detailed Description

Interface for spools.

Author

Fabien Potencier

Definition at line 16 of file Spool.php.

Member Function Documentation

flushQueue	(	Swift_Transport	$transport,
		&	$failedRecipients = null
	)

Sends messages using the given transport instance.

Parameters

Swift_Transport	$transport	A transport instance
	string[]	$failedRecipients An array of failures by-reference

Returns

int The number of sent emails

Implemented in Swift_FileSpool, and Swift_MemorySpool.

isStarted

(

)

Tests if this Spool mechanism has started.

Returns

bool

Implemented in Swift_FileSpool, and Swift_MemorySpool.

queueMessage

(

Swift_Mime_Message

$message

)

Queues a message.

Parameters

Swift_Mime_Message

$message

The message to store

Returns

bool Whether the operation has succeeded

Implemented in Swift_FileSpool, and Swift_MemorySpool.

start

(

)

Starts this Spool mechanism.

Implemented in Swift_FileSpool, and Swift_MemorySpool.

stop

(

)

Stops this Spool mechanism.

Implemented in Swift_FileSpool, and Swift_MemorySpool.