Swift_MemorySpool
in package
implements
Swift_Spool
Stores Messages in memory.
Tags
Interfaces, Classes and Traits
- Swift_Spool
- Interface for spools.
Table of Contents
- $messages : mixed
- $flushRetries : mixed
- flushQueue() : int
- Sends messages using the given transport instance.
- isStarted() : bool
- Tests if this Transport mechanism has started.
- queueMessage() : bool
- Stores a message in the queue.
- setFlushRetries() : mixed
- start() : mixed
- Starts this Transport mechanism.
- stop() : mixed
- Stops this Transport mechanism.
Properties
$messages
protected
mixed
$messages
= []
$flushRetries
private
mixed
$flushRetries
= 3
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 Transport mechanism has started.
public
isStarted() : bool
Return values
bool —queueMessage()
Stores a message in the queue.
public
queueMessage(Swift_Mime_SimpleMessage $message) : bool
Parameters
- $message : Swift_Mime_SimpleMessage
-
The message to store
Return values
bool —Whether the operation has succeeded
setFlushRetries()
public
setFlushRetries(int $retries) : mixed
Parameters
- $retries : int
Return values
mixed —start()
Starts this Transport mechanism.
public
start() : mixed
Return values
mixed —stop()
Stops this Transport mechanism.
public
stop() : mixed