Class Swift_FileSpool

Stores Messages on the filesystem.

Swift_ConfigurableSpool implements Swift_Spool

Swift_FileSpool

Package: Swift
Author: Fabien Potencier
Author: Xavier De Cock <xdecock@gmail.com>
Located at vendors/swiftmailer/lib/classes/Swift/FileSpool.php

Methods summary

`public`	# `__construct( string $path )` Create a new FileSpool. Create a new FileSpool. Parameters `$path` `string` $path Throws `Swift_IoException`
`public boolean`	# `isStarted( )` Tests if this Spool mechanism has started. Tests if this Spool mechanism has started. Returns `boolean`
`public`	# `start( )` Starts this Spool mechanism. Starts this Spool mechanism.
`public`	# `stop( )` Stops this Spool mechanism. Stops this Spool mechanism.
`public`	# `setRetryLimit( integer $limit )` Allow to manage the enqueuing retry limit. Default, is ten and allows over 64²⁰ different fileNames Allow to manage the enqueuing retry limit. Default, is ten and allows over 64²⁰ different fileNames Parameters `$limit` `integer` $limit
`public boolean`	# `queueMessage( Swift_Mime_Message $message )` Queues a message. Queues a message. Parameters `$message` `Swift_Mime_Message` $message The message to store Returns `boolean` Throws `Swift_IoException`
`public`	# `recover( integer $timeout = 900 )` Execute a recovery if for anyreason a process is sending for too long Execute a recovery if for anyreason a process is sending for too long Parameters `$timeout` `integer` $timeout in second Defaults is for very slow smtp responses
`public integer`	# `flushQueue( Swift_Transport $transport, string[] & $failedRecipients = null )` Sends messages using the given transport instance. Sends messages using the given transport instance. Parameters `$transport` `Swift_Transport` $transport A transport instance `$failedRecipients` `string[]` &$failedRecipients An array of failures by-reference Returns `integer` The number of sent emails
`protected`	# `getRandomString( integer $count )` Returns a random string needed to generate a fileName for the queue. Returns a random string needed to generate a fileName for the queue. Parameters `$count` `integer` $count

Methods inherited from Swift_ConfigurableSpool

getMessageLimit(), getTimeLimit(), setMessageLimit(), setTimeLimit()

Magic methods summary

Properties summary

`private mixed`	`$_path`	# The spool directory The spool directory
`private integer`	`$_retryLimit`	# File WriteRetry Limit File WriteRetry Limit

Packages

Classes

Interfaces

Exceptions

Class Swift_FileSpool

Methods summary

Parameters

Throws

Returns

Parameters

Parameters

Returns

Throws

Parameters

Parameters

Returns

Parameters

Methods inherited from Swift_ConfigurableSpool

Magic methods summary

Properties summary