Docs For Class Swift_Transport

Class: Swift_Transport_MailTransport

Child classes:

Swift_MailTransport: Sends Messages using the mail() function.

Class Details

[line 31]
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
filesource:	Source Code for this file

Class Methods

constructor __construct [line 47]

Swift_Transport_MailTransport __construct(
Swift_Transport_MailInvoker
$invoker, Swift_Events_EventDispatcher
$eventDispatcher, Swift_Transport_Log
$log)

Create a new MailTransport with the $log.

Parameters:

Swift_Transport_Log	$log
Swift_Transport_MailInvoker	$invoker
Swift_Events_EventDispatcher	$eventDispatcher

[ Top ]

method getExtraParams [line 96]

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

void isStarted(
)

Not used.

method registerPlugin [line 211]

void registerPlugin(
Swift_Events_EventListener
$plugin)

Parameters:

Swift_Events_EventListener

$plugin

[ Top ]

method send [line 111]

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.

Parameters:

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

[ Top ]

method setExtraParams [line 83]

void 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 65]

void start(
)

Not used.

method stop [line 72]

void stop(
)

Not used.

Class: Swift_Transport_MailTransport

Class Overview

Author(s):

Methods

Child classes:

Class Details

Tags:

Class Methods

constructor __construct [line 47]

Tags:

Parameters:

method getExtraParams [line 96]

Tags:

method isStarted [line 57]

Tags:

method registerPlugin [line 211]

Tags:

Parameters:

method send [line 111]

Tags:

Parameters:

method setExtraParams [line 83]

Tags:

Parameters:

method start [line 65]

Tags:

method stop [line 72]

Tags: