Swift_Transport_MailTransport Class Reference

Inheritance diagram for Swift_Transport_MailTransport:

Public Member Functions
	__construct (Swift_Transport_MailInvoker $invoker, Swift_Events_EventDispatcher $eventDispatcher)
	isStarted ()
	start ()
	stop ()
	setExtraParams ($params)
	getExtraParams ()
	send (Swift_Mime_Message $message, &$failedRecipients=null)
	registerPlugin (Swift_Events_EventListener $plugin)

Protected Member Functions
	_throwException (Swift_TransportException $e)

Private Member Functions
	_getReversePath (Swift_Mime_Message $message)

Private Attributes
	$_extraParams = '-f%s'
	$_eventDispatcher
	$_invoker

Detailed Description

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.

Author

Chris Corbyn

Definition at line 24 of file Transport/MailTransport.php.

Constructor & Destructor Documentation

__construct	(	Swift_Transport_MailInvoker	$invoker,
		Swift_Events_EventDispatcher	$eventDispatcher
	)

Create a new MailTransport with the $log.

Parameters

Swift_Transport_MailInvoker	$invoker
Swift_Events_EventDispatcher	$eventDispatcher

Definition at line 41 of file Transport/MailTransport.php.

Member Function Documentation

_getReversePath ( Swift_Mime_Message  $message )

private

Determine the best-use reverse path for this message

Definition at line 219 of file Transport/MailTransport.php.

References elseif, Swift_Mime_Message\getFrom(), Swift_Mime_Message\getReturnPath(), and Swift_Mime_Message\getSender().

Referenced by send().

_throwException ( Swift_TransportException  $e )

protected

Throw a TransportException, first sending it to any listeners

Definition at line 206 of file Transport/MailTransport.php.

Referenced by send().

getExtraParams

(

)

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

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

Returns

string

Definition at line 92 of file Transport/MailTransport.php.

References $_extraParams.

isStarted

(

)

Not used.

Implements Swift_Transport.

Definition at line 50 of file Transport/MailTransport.php.

registerPlugin

(

Swift_Events_EventListener

$plugin

)

Register a plugin.

Parameters

Swift_Events_EventListener

$plugin

Implements Swift_Transport.

Definition at line 200 of file Transport/MailTransport.php.

send	(	Swift_Mime_Message	$message,
		&	$failedRecipients = null
	)

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.

Parameters

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

Returns

int

Implements Swift_Transport.

Definition at line 108 of file Transport/MailTransport.php.

References _getReversePath(), _throwException(), Swift_Mime_Message\generateId(), Swift_Mime_Message\getBcc(), Swift_Mime_Message\getCc(), Swift_Mime_MimeEntity\getHeaders(), Swift_Mime_Message\getTo(), Swift_Events_SendEvent\RESULT_FAILED, Swift_Events_SendEvent\RESULT_SUCCESS, and Swift_Mime_MimeEntity\toString().

setExtraParams

(

$params

)

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

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

Parameters

string

$params

Returns

Swift_Transport_MailTransport

Definition at line 78 of file Transport/MailTransport.php.

Referenced by Swift_MailTransport\__construct().

start

(

)

Not used.

Implements Swift_Transport.

Definition at line 58 of file Transport/MailTransport.php.

stop

(

)

Not used.

Implements Swift_Transport.

Definition at line 65 of file Transport/MailTransport.php.

Member Data Documentation

$_eventDispatcher

private

The event dispatcher from the plugin API

Definition at line 30 of file Transport/MailTransport.php.

$_extraParams = '-f%s'

private

Additional parameters to pass to mail()

Definition at line 27 of file Transport/MailTransport.php.

Referenced by getExtraParams().

$_invoker

private

An invoker that calls the mail() function

Definition at line 33 of file Transport/MailTransport.php.