Stores Messages on the filesystem.

package Swift
author Fabien Potencier
author Xavier De Cock

 Methods

Create a new FileSpool.

__construct(string $path) 

Parameters

$path

string

Exceptions

\Swift_IoException

Sends messages using the given transport instance.

flushQueue(\Swift_Transport $transport, string[] $failedRecipients) : int

Parameters

$transport

\Swift_Transport

A transport instance

$failedRecipients

string[]

&$failedRecipients An array of failures by-reference

Returns

intThe number of sent emails

Gets the maximum number of messages to send per flush.

getMessageLimit() : int
Inherited
inherited_from \Swift_ConfigurableSpool::getMessageLimit()

Returns

intThe limit

Gets the time limit (in seconds) per flush.

getTimeLimit() : int
Inherited
inherited_from \Swift_ConfigurableSpool::getTimeLimit()

Returns

intThe limit

Tests if this Spool mechanism has started.

isStarted() : boolean

Returns

boolean

Queues a message.

queueMessage(\Swift_Mime_Message $message) : boolean

Parameters

$message

\Swift_Mime_Message

The message to store

Exceptions

\Swift_IoException

Returns

boolean

Execute a recovery if for anyreason a process is sending for too long

recover(int $timeout) 

Parameters

$timeout

int

in second Defaults is for very slow smtp responses

Sets the maximum number of messages to send per flush.

setMessageLimit(int $limit) 
Inherited
inherited_from \Swift_ConfigurableSpool::setMessageLimit()

Parameters

$limit

int

The limit

Allow to manage the enqueuing retry limit.

setRetryLimit(integer $limit) 

Default, is ten and allows over 64^20 different fileNames

Parameters

$limit

integer

Sets the time limit (in seconds) per flush.

setTimeLimit(int $limit) 
Inherited
inherited_from \Swift_ConfigurableSpool::setTimeLimit()

Parameters

$limit

int

The limit

Starts this Spool mechanism.

start() 

Stops this Spool mechanism.

stop() 

Returns a random string needed to generate a fileName for the queue.

getRandomString(int $count) 

Parameters

$count

int

 Properties

 

$_message_limit 
Inherited
inherited_from \Swift_ConfigurableSpool::$$_message_limit
 

$_path 
 

$_retryLimit : int
 

$_time_limit 
Inherited
inherited_from \Swift_ConfigurableSpool::$$_time_limit