W3cubDocs

/Laravel 5.1

Mailer

class Mailer implements Mailer, MailQueue (View source)

Methods

void

__construct( Factory $views, Swift_Mailer $swift, Dispatcher $events = null)

Create a new Mailer instance.

void

alwaysFrom( string $address, string|null $name = null)

Set the global from address and name.

void

alwaysTo( string $address, string|null $name = null)

Set the global to address and name.

int

raw( string $text, Closure|string $callback)

Send a new message when only a raw text part.

int

plain( string $view, array $data, mixed $callback)

Send a new message when only a plain part.

void

send( string|array $view, array $data, Closure|string $callback)

Send a new message using a view.

mixed

queue( string|array $view, array $data, Closure|string $callback, string $queue = null)

Queue a new e-mail message for sending.

mixed

onQueue( string $queue, string|array $view, array $data, Closure|string $callback)

Queue a new e-mail message for sending on the given queue.

mixed

queueOn( string $queue, string|array $view, array $data, Closure|string $callback)

Queue a new e-mail message for sending on the given queue.

mixed

later( int $delay, string|array $view, array $data, Closure|string $callback, string $queue = null)

Queue a new e-mail message for sending after (n) seconds.

mixed

laterOn( string $queue, int $delay, string|array $view, array $data, Closure|string $callback)

Queue a new e-mail message for sending after (n) seconds on the given queue.

void

handleQueuedMessage( Job $job, array $data)

Handle a queued e-mail message job.

void

pretend( bool $value = true)

Tell the mailer to not really send messages.

bool

isPretending()

Check if the mailer is pretending to send messages.

Factory

getViewFactory()

Get the view factory instance.

Swift_Mailer

getSwiftMailer()

Get the Swift Mailer instance.

array

failures()

Get the array of failed recipients.

void

setSwiftMailer( Swift_Mailer $swift)

Set the Swift Mailer instance.

$this

setLogger( LoggerInterface $logger)

Set the log writer instance.

$this

setQueue( Queue $queue)

Set the queue manager instance.

void

setContainer( Container $container)

Set the IoC container instance.

Details

void __construct( Factory $views, Swift_Mailer $swift, Dispatcher $events = null)

Create a new Mailer instance.

Parameters

Factory	$views
Swift_Mailer	$swift
Dispatcher	$events

Return Value

void

void alwaysFrom( string $address, string|null $name = null)

Set the global from address and name.

Parameters

string	$address
string\|null	$name

Return Value

void

void alwaysTo( string $address, string|null $name = null)

Set the global to address and name.

Parameters

string	$address
string\|null	$name

Return Value

void

int raw( string $text, Closure|string $callback)

Send a new message when only a raw text part.

Parameters

string	$text
Closure\|string	$callback

Return Value

int

int plain( string $view, array $data, mixed $callback)

Send a new message when only a plain part.

Parameters

string	$view
array	$data
mixed	$callback

Return Value

int

void send( string|array $view, array $data, Closure|string $callback)

Send a new message using a view.

Parameters

string\|array	$view
array	$data
Closure\|string	$callback

Return Value

void

mixed queue( string|array $view, array $data, Closure|string $callback, string $queue = null)

Queue a new e-mail message for sending.

Parameters

string\|array	$view
array	$data
Closure\|string	$callback
string	$queue

Return Value

mixed

mixed onQueue( string $queue, string|array $view, array $data, Closure|string $callback)

Queue a new e-mail message for sending on the given queue.

Parameters

string	$queue
string\|array	$view
array	$data
Closure\|string	$callback

Return Value

mixed

mixed queueOn( string $queue, string|array $view, array $data, Closure|string $callback)

Queue a new e-mail message for sending on the given queue.

This method didn't match rest of framework's "onQueue" phrasing. Added "onQueue".

Parameters

string	$queue
string\|array	$view
array	$data
Closure\|string	$callback

Return Value

mixed

mixed later( int $delay, string|array $view, array $data, Closure|string $callback, string $queue = null)

Queue a new e-mail message for sending after (n) seconds.

Parameters

int	$delay
string\|array	$view
array	$data
Closure\|string	$callback
string	$queue

Return Value

mixed

mixed laterOn( string $queue, int $delay, string|array $view, array $data, Closure|string $callback)

Queue a new e-mail message for sending after (n) seconds on the given queue.

Parameters

string	$queue
int	$delay
string\|array	$view
array	$data
Closure\|string	$callback

Return Value

mixed

void handleQueuedMessage( Job $job, array $data)

Handle a queued e-mail message job.

Parameters

Job	$job
array	$data

Return Value

void

void pretend( bool $value = true)

Tell the mailer to not really send messages.

Parameters

bool

$value

Return Value

void

bool isPretending()

Check if the mailer is pretending to send messages.

Return Value

bool

Factory getViewFactory()

Get the view factory instance.

Return Value

Factory

Swift_Mailer getSwiftMailer()

Get the Swift Mailer instance.

Return Value

Swift_Mailer

array failures()

Get the array of failed recipients.

Return Value

array

void setSwiftMailer( Swift_Mailer $swift)

Set the Swift Mailer instance.

Parameters

Swift_Mailer

$swift

Return Value

void

$this setLogger( LoggerInterface $logger)

Set the log writer instance.

Parameters

LoggerInterface

$logger

Return Value

$this

$this setQueue( Queue $queue)

Set the queue manager instance.

Parameters

Queue

$queue

Return Value

$this

void setContainer( Container $container)

Set the IoC container instance.

Parameters

Container

$container

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Mail/Mailer.html