Interface Swift_Spool

Implemented bySwift_ConfigurableSpool, Swift_FileSpool, Swift_MemorySpool

Interface for spools.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
flushQueue() Sends messages using the given transport instance. Swift_Spool
isStarted() Tests if this Spool mechanism has started. Swift_Spool
queueMessage() Queues a message. Swift_Spool
start() Starts this Spool mechanism. Swift_Spool
stop() Stops this Spool mechanism. Swift_Spool

Method Details

flushQueue() public abstract method

Sends messages using the given transport instance.

public abstract int flushQueue ( Swift_Transport $transport, &$failedRecipients null )
$transport Swift_Transport

A transport instance

$failedRecipients string[]

An array of failures by-reference

return int

The number of sent emails

isStarted() public abstract method

Tests if this Spool mechanism has started.

public abstract bool isStarted ( )
queueMessage() public abstract method

Queues a message.

public abstract bool queueMessage ( Swift_Mime_Message $message )
$message Swift_Mime_Message

The message to store

return bool

Whether the operation has succeeded

start() public abstract method

Starts this Spool mechanism.

public abstract void start ( )
stop() public abstract method

Stops this Spool mechanism.

public abstract void stop ( )