Swift_Transport_MailTransport Class Reference

Inheritance diagram for Swift_Transport_MailTransport:

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

Private Member Functions
	_getReversePath (Swift_Mime_Message $message)

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

Detailed Description

Definition at line 31 of file MailTransport.php.

Constructor & Destructor Documentation

Swift_Transport_MailTransport::__construct	(	Swift_Transport_MailInvoker	$invoker,
		Swift_Events_EventDispatcher	$eventDispatcher
	)

Create a new MailTransport with the $log.

Parameters

Swift_Transport_Log

$log

Definition at line 47 of file MailTransport.php.

Member Function Documentation

Swift_Transport_MailTransport::_getReversePath ( Swift_Mime_Message  $message )

private

Determine the best-use reverse path for this message

Definition at line 219 of file MailTransport.php.

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

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Transport_MailTransport::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 96 of file MailTransport.php.

References $_extraParams.

Swift_Transport_MailTransport::isStarted

(

)

Not used.

Implements Swift_Transport.

Definition at line 57 of file MailTransport.php.

Swift_Transport_MailTransport::registerPlugin

(

Swift_Events_EventListener

$plugin

)

Register a plugin.

Parameters

Swift_Events_EventListener

$plugin

Implements Swift_Transport.

Definition at line 211 of file MailTransport.php.

Swift_Transport_MailTransport::send	(	Swift_Mime_Message	$message,
		&	$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.

Parameters

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

Returns

int

Implements Swift_Transport.

Definition at line 111 of file MailTransport.php.

References _getReversePath(), 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().

Here is the call graph for this function:

Swift_Transport_MailTransport::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

Definition at line 83 of file MailTransport.php.

Referenced by Swift_MailTransport\__construct().

Here is the caller graph for this function:

Swift_Transport_MailTransport::start

(

)

Not used.

Implements Swift_Transport.

Definition at line 65 of file MailTransport.php.

Swift_Transport_MailTransport::stop

(

)

Not used.

Implements Swift_Transport.

Definition at line 72 of file MailTransport.php.

Member Data Documentation

Swift_Transport_MailTransport::$_eventDispatcher

private

The event dispatcher from the plugin API

Definition at line 38 of file MailTransport.php.

Swift_Transport_MailTransport::$_extraParams = '-f%s'

private

Addtional parameters to pass to mail()

Definition at line 35 of file MailTransport.php.

Referenced by getExtraParams().

Swift_Transport_MailTransport::$_invoker

private

An invoker that calls the mail() function

Definition at line 41 of file MailTransport.php.

---

The documentation for this class was generated from the following file:

• L:/XOOPS_Allure/SVN_XOOPS2/RMC/rmcommon/trunk/rmcommon/class/swift/classes/Swift/Transport/MailTransport.php