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

Class: Swift_Transport

Source Location: /vendors/swift/classes/Swift/Transport.php

Interface Overview


Sends Messages via an abstract Transport subsystem.


Author(s):

  • Chris Corbyn

Methods



Class Details

[line 21]
Sends Messages via an abstract Transport subsystem.



Tags:

author:  Chris Corbyn
filesource:  Source Code for this file


[ Top ]


Class Methods


method isStarted [line 29]

boolean isStarted( )

Test if this Transport mechanism has started.



Tags:

access:  public


[ Top ]

method registerPlugin [line 58]

void registerPlugin( Swift_Events_EventListener $plugin)

Register a plugin in the Transport.



Tags:

access:  public


Parameters:

Swift_Events_EventListener   $plugin  

[ Top ]

method send [line 51]

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

Send the given Message.

Recipient/sender data will be retreived from the Message API. The return value is the number of recipients who were accepted for delivery.




Tags:

access:  public


Parameters:

Swift_Mime_Message   $message  
string[]   &$failedRecipients   to collect failures by-reference

[ Top ]

method start [line 34]

void start( )

Start this Transport mechanism.



Tags:

access:  public


[ Top ]

method stop [line 39]

void stop( )

Stop this Transport mechanism.



Tags:

access:  public


[ Top ]


Documentation generated on Mon, 05 Sep 2011 20:34:45 -0500 by phpDocumentor 1.4.3