Swift_Mailer Class Reference

Inheritance diagram for Swift_Mailer:

Public Member Functions
	__construct (Swift_Transport $transport)
	createMessage ($service= 'message')
	send (Swift_Mime_Message $message, &$failedRecipients=null)
	registerPlugin (Swift_Events_EventListener $plugin)
	getTransport ()

Static Public Member Functions
static	newInstance (Swift_Transport $transport)

Private Attributes
	$_transport

Detailed Description

Swift Mailer class.

Author

Chris Corbyn

Definition at line 16 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mailer.php.

Constructor & Destructor Documentation

__construct

(

Swift_Transport

$transport

)

Create a new Mailer using $transport for delivery.

Parameters

Swift_Transport

$transport

Definition at line 26 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mailer.php.

Member Function Documentation

createMessage

(

$service = 'message'

)

Create a new class instance of one of the message services.

For example 'mimepart' would create a 'message.mimepart' instance

Parameters

string

$service

Returns

object

Definition at line 52 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mailer.php.

References Swift_DependencyContainer\getInstance().

getTransport

(

)

The Transport used to send messages.

Returns

Swift_Transport

Definition at line 110 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mailer.php.

References $_transport.

static newInstance ( Swift_Transport  $transport )

static

Create a new Mailer instance.

Parameters

Swift_Transport

$transport

Returns

Swift_Mailer

Definition at line 38 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mailer.php.

registerPlugin

(

Swift_Events_EventListener

$plugin

)

Register a plugin using a known unique key (e.g. myPlugin).

Parameters

Swift_Events_EventListener

$plugin

Definition at line 100 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mailer.php.

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

Send the given Message like it would be sent in a mail client.

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

Swift_Mime_Message	$message
array	$failedRecipients	An array of failures by-reference

Returns

int

Definition at line 74 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mailer.php.

References Swift_Mime_Message\getTo().

Member Data Documentation

$_transport

private

The Transport used to send messages

Definition at line 19 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mailer.php.

Referenced by getTransport().