SwiftMailerTest
extends Swift_Mailer
in package
Swift Mailer class.
Table of Contents
- $transport : mixed
- The Transport used to send messages
- __construct() : mixed
- Create a new Mailer using $transport for delivery.
- createMessage() : object
- Create a new class instance of one of the message services.
- getTransport() : Swift_Transport
- The Transport used to send messages.
- registerPlugin() : mixed
- Register a plugin using a known unique key (e.g. myPlugin).
- send() : int
- Send the given Message like it would be sent in a mail client.
Properties
$transport
The Transport used to send messages
private
mixed
$transport
Methods
__construct()
Create a new Mailer using $transport for delivery.
public
__construct() : mixed
Return values
mixed —createMessage()
Create a new class instance of one of the message services.
public
createMessage([string $service = 'message' ]) : object
For example 'mimepart' would create a 'message.mimepart' instance
Parameters
- $service : string = 'message'
Return values
object —getTransport()
The Transport used to send messages.
public
getTransport() : Swift_Transport
Return values
Swift_Transport —registerPlugin()
Register a plugin using a known unique key (e.g. myPlugin).
public
registerPlugin(Swift_Events_EventListener $plugin) : mixed
Parameters
- $plugin : Swift_Events_EventListener
Return values
mixed —send()
Send the given Message like it would be sent in a mail client.
public
send(Swift_Mime_SimpleMessage $message[, array<string|int, mixed> &$failedRecipients = null ]) : int
All recipients (with the exception of Bcc) will be able to see the other recipients this message was sent to.
Recipient/sender data will be retrieved from the Message object.
The return value is the number of recipients who were accepted for delivery.
Parameters
- $message : Swift_Mime_SimpleMessage
- $failedRecipients : array<string|int, mixed> = null
-
An array of failures by-reference
Return values
int —The number of successful recipients. Can be 0 which indicates failure