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

Class: Swift_Transport_SpoolTransport

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

Class Overview


Stores Messages in a queue.


Author(s):

  • Fabien Potencier

Implements interfaces:

Methods


Child classes:

Swift_SpoolTransport
Stores Messages in a queue.

Class Details

[line 16]
Stores Messages in a queue.



Tags:

author:  Fabien Potencier


[ Top ]


Class Methods


constructor __construct [line 27]

Swift_Transport_SpoolTransport __construct( Swift_Events_EventDispatcher $eventDispatcher, [Swift_Spool $spool = null])

Constructor.



Tags:

access:  public


Overridden in child classes as:

Swift_SpoolTransport::__construct()
Create a new SpoolTransport.

Parameters:

Swift_Events_EventDispatcher   $eventDispatcher  
Swift_Spool   $spool  

[ Top ]

method getSpool [line 52]

Swift_Spool getSpool( )

Get the spool object.



Tags:

access:  public


[ Top ]

method isStarted [line 62]

bool isStarted( )

Tests if this Transport mechanism has started.



Tags:

access:  public



Implementation of:
Swift_Transport::isStarted()
Test if this Transport mechanism has started.
[ Top ]

method registerPlugin [line 113]

void registerPlugin( Swift_Events_EventListener $plugin)

Register a plugin.



Tags:

access:  public



Implementation of:
Swift_Transport::registerPlugin()
Register a plugin in the Transport.

Parameters:

Swift_Events_EventListener   $plugin  

[ Top ]

method send [line 89]

int send( Swift_Mime_Message $message, [ &$failedRecipients = null], string[] $failedRecipients)

Sends the given message.



Tags:

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



Implementation of:
Swift_Transport::send()
Send the given Message.

Parameters:

Swift_Mime_Message   $message  
string[]   $failedRecipients   An array of failures by-reference
   &$failedRecipients  

[ Top ]

method setSpool [line 40]

Swift_Transport_SpoolTransport setSpool( Swift_Spool $spool)

Sets the spool object.



Tags:

access:  public


Parameters:

Swift_Spool   $spool  

[ Top ]

method start [line 70]

void start( )

Starts this Transport mechanism.



Tags:

access:  public



Implementation of:
Swift_Transport::start()
Start this Transport mechanism.
[ Top ]

method stop [line 77]

void stop( )

Stops this Transport mechanism.



Tags:

access:  public



Implementation of:
Swift_Transport::stop()
Stop this Transport mechanism.
[ Top ]


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