PHP Class Swift_Transport_MailTransport

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.

Author: Chris Corbyn

Inheritance: implements Swift_Transport

Mostra file Open project: swiftmailer/swiftmailer

Public Methods

Method	Description
__construct ( Swift_Events_EventDispatcher $eventDispatcher )	Create a new MailTransport with the $log.
getExtraParams ( ) : string	Get the additional parameters used on the mail() function.
isStarted ( )	Not used.
mail ( string $to, string $subject, string $body, string $headers = null, string $extraParams = null ) : boolean	Send mail via the mail() function.
registerPlugin ( Swift_Events_EventListener $plugin )	Register a plugin.
send ( Swift_Mime_Message $message, string[] &$failedRecipients = null ) : integer	Send the given Message.
setExtraParams ( string $params ) : Swift_Transport_MailTransport	Set the additional parameters used on the mail() function.
start ( )	Not used.
stop ( )	Not used.

Protected Methods

Method	Description
throwException ( Swift_TransportException $e )	Throw a TransportException, first sending it to any listeners

Private Methods

Method	Description
formatExtraParams ( $extraParams, $reversePath ) : string \| null	Return php mail extra params to use for invoker->mail.
getReversePath ( Swift_Mime_Message $message )	Determine the best-use reverse path for this message

Method Details

__construct() public method

Create a new MailTransport with the $log.

public __construct ( Swift_Events_EventDispatcher $eventDispatcher )
$eventDispatcher	Swift_Events_EventDispatcher

getExtraParams() public method

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

public getExtraParams ( ) : string
return	string

isStarted() public method

Not used.

public isStarted ( )

mail() public method

This method takes the same arguments as PHP mail().

public mail ( string $to, string $subject, string $body, string $headers = null, string $extraParams = null ) : boolean
$to	string
$subject	string
$body	string
$headers	string
$extraParams	string
return	boolean

registerPlugin() public method

public registerPlugin ( Swift_Events_EventListener $plugin )
$plugin	Swift_Events_EventListener

send() public method

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

public send ( Swift_Mime_Message $message, string[] &$failedRecipients = null ) : integer
$message	Swift_Mime_Message
$failedRecipients	string[]	An array of failures by-reference
return	integer

setExtraParams() public method

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

public setExtraParams ( string $params ) : Swift_Transport_MailTransport
$params	string
return	Swift_Transport_MailTransport

start() public method

Not used.

public start ( )

stop() public method

Not used.

public stop ( )

throwException() protected method

Throw a TransportException, first sending it to any listeners

protected throwException ( Swift_TransportException $e )
$e	Swift_TransportException