Swift_Spool
in
Interface for spools.
Tags
Table of Contents
- flushQueue() : int
- Sends messages using the given transport instance.
- isStarted() : bool
- Tests if this Spool mechanism has started.
- queueMessage() : bool
- Queues a message.
- start() : mixed
- Starts this Spool mechanism.
- stop() : mixed
- Stops this Spool mechanism.
Methods
flushQueue()
Sends messages using the given transport instance.
public
flushQueue(Swift_Transport $transport[, array<string|int, string> &$failedRecipients = null ]) : int
Parameters
- $transport : Swift_Transport
-
A transport instance
- $failedRecipients : array<string|int, string> = null
-
An array of failures by-reference
Return values
int —The number of sent emails
isStarted()
Tests if this Spool mechanism has started.
public
isStarted() : bool
Return values
bool —queueMessage()
Queues a message.
public
queueMessage(Swift_Mime_SimpleMessage $message) : bool
Parameters
- $message : Swift_Mime_SimpleMessage
-
The message to store
Return values
bool —Whether the operation has succeeded
start()
Starts this Spool mechanism.
public
start() : mixed
Return values
mixed —stop()
Stops this Spool mechanism.
public
stop() : mixed