Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_FileSpool

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/FileSpool.php

Class Overview

Swift_ConfigurableSpool
   |
   --Swift_FileSpool

Stores Messages on the filesystem.


Author(s):

Methods


Inherited Methods

Class: Swift_ConfigurableSpool

Swift_ConfigurableSpool::getMessageLimit()
Gets the maximum number of messages to send per flush.
Swift_ConfigurableSpool::getTimeLimit()
Gets the time limit (in seconds) per flush.
Swift_ConfigurableSpool::setMessageLimit()
Sets the maximum number of messages to send per flush.
Swift_ConfigurableSpool::setTimeLimit()
Sets the time limit (in seconds) per flush.

Class Details

[line 17]
Stores Messages on the filesystem.



Tags:

author:  Fabien Potencier
author:  Xavier De Cock <xdecock@gmail.com>


[ Top ]


Class Methods


constructor __construct [line 36]

Swift_FileSpool __construct( string $path)

Create a new FileSpool.



Tags:

throws:  Swift_IoException
access:  public


Parameters:

string   $path  

[ Top ]

method flushQueue [line 141]

int flushQueue( Swift_Transport $transport, [ &$failedRecipients = null], string[] $failedRecipients)

Sends messages using the given transport instance.



Tags:

return:  The number of sent e-mail's
access:  public


Parameters:

Swift_Transport   $transport   A transport instance
string[]   $failedRecipients   An array of failures by-reference
   &$failedRecipients  

[ Top ]

method getRandomString [line 196]

string getRandomString( int $count)

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



Tags:

access:  protected


Parameters:

int   $count  

[ Top ]

method isStarted [line 52]

bool isStarted( )

Tests if this Spool mechanism has started.



Tags:

access:  public


[ Top ]

method queueMessage [line 92]

bool queueMessage( Swift_Mime_Message $message)

Queues a message.



Tags:

throws:  Swift_IoException
access:  public


Parameters:

Swift_Mime_Message   $message   The message to store

[ Top ]

method recover [line 119]

void recover( [int $timeout = 900])

Execute a recovery if for any reason a process is sending for too long.



Tags:

access:  public


Parameters:

int   $timeout   in second Defaults is for very slow smtp responses

[ Top ]

method setRetryLimit [line 78]

void setRetryLimit( int $limit)

Allow to manage the enqueuing retry limit.

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




Tags:

access:  public


Parameters:

int   $limit  

[ Top ]

method start [line 60]

void start( )

Starts this Spool mechanism.



Tags:

access:  public


[ Top ]

method stop [line 67]

void stop( )

Stops this Spool mechanism.



Tags:

access:  public


[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:48:54 +0000 by phpDocumentor 1.4.3