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

Class: Swift_Spool

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

Interface Overview


Interface for spools.


Author(s):

  • Fabien Potencier

Methods



Class Details

[line 16]
Interface for spools.



Tags:

author:  Fabien Potencier


[ Top ]


Class Methods


method flushQueue [line 52]

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

Sends messages using the given transport instance.



Tags:

return:  The number of sent emails
access:  public


Parameters:

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

[ Top ]

method isStarted [line 33]

bool isStarted( )

Tests if this Spool mechanism has started.



Tags:

access:  public


[ Top ]

method queueMessage [line 42]

bool queueMessage( Swift_Mime_Message $message)

Queues a message.



Tags:

return:  Whether the operation has succeeded
access:  public


Parameters:

Swift_Mime_Message   $message   The message to store

[ Top ]

method start [line 21]

void start( )

Starts this Spool mechanism.



Tags:

access:  public


[ Top ]

method stop [line 26]

void stop( )

Stops this Spool mechanism.



Tags:

access:  public


[ Top ]


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