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

Class: Swift_Transport_MailTransport

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

Class Overview


Sends Messages using the mail() function.


Author(s):

  • Chris Corbyn

Implements interfaces:

Methods


Child classes:

Swift_MailTransport
Sends Messages using the mail() function.

Class Details

[line 24]
Sends Messages using the mail() function.

It is advised that users do not use this transport if at all possible since a number of plugin features cannot be used in conjunction with this transport due to the internal interface in PHP itself.

The level of error reporting with this transport is incredibly weak, again due to limitations of PHP's internal mail() function. You'll get an all-or-nothing result from sending.




Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 41]

Swift_Transport_MailTransport __construct( Swift_Transport_MailInvoker $invoker, Swift_Events_EventDispatcher $eventDispatcher)

Create a new MailTransport with the $log.



Tags:

access:  public


Overridden in child classes as:

Swift_MailTransport::__construct()
Create a new MailTransport, optionally specifying $extraParams.

Parameters:

Swift_Transport_MailInvoker   $invoker  
Swift_Events_EventDispatcher   $eventDispatcher  

[ Top ]

method getExtraParams [line 92]

string getExtraParams( )

Get the additional parameters used on the mail() function.

This string is formatted for sprintf() where %s is the sender address.




Tags:

access:  public


[ Top ]

method isStarted [line 50]

void isStarted( )

Not used.



Tags:

access:  public



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

method registerPlugin [line 203]

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 108]

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

Send the given Message.

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




Tags:

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 setExtraParams [line 78]

Swift_Transport_MailTransport setExtraParams( string $params)

Set the additional parameters used on the mail() function.

This string is formatted for sprintf() where %s is the sender address.




Tags:

access:  public


Parameters:

string   $params  

[ Top ]

method start [line 58]

void start( )

Not used.



Tags:

access:  public



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

method stop [line 65]

void stop( )

Not used.



Tags:

access:  public



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

method _throwException [line 209]

void _throwException( Swift_TransportException $e)

Throw a TransportException, first sending it to any listeners



Tags:

access:  protected


Parameters:


[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:52:09 +0000 by phpDocumentor 1.4.3