W3cubDocs

/Laravel 5.4

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 alwaysReplyTo(string $address, string|null $name = null)

Set the global reply-to address and name.
void alwaysTo(string $address, string|null $name = null)

Set the global to address and name.
PendingMail to(mixed $users)

Begin the process of mailing a mailable class instance.
PendingMail bcc(mixed $users)

Begin the process of mailing a mailable class instance.
int raw(string $text, Closure|string $callback)

Send a new message when only a raw text part.
void plain(string $view, array $data, mixed $callback)

Send a new message when only a plain part.
void send(string|array $view, array $data = array(), Closure|string $callback = null)

Send a new message using a view.
mixed queue(string|array $view, array $data = array(), Closure|string $callback = null, 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 = array(), Closure|string $callback = null, 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.
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 setQueue(Factory $queue)

Set the queue manager 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 alwaysReplyTo(string $address, string|null $name = null)

Set the global reply-to 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

PendingMail to(mixed $users)

Begin the process of mailing a mailable class instance.

Parameters

mixed $users

Return Value

PendingMail

PendingMail bcc(mixed $users)

Begin the process of mailing a mailable class instance.

Parameters

mixed $users

Return Value

PendingMail

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

void 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

void

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

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 = array(), Closure|string $callback = null, 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 = array(), Closure|string $callback = null, 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

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 setQueue(Factory $queue)

Set the queue manager instance.

Parameters

Factory $queue

Return Value

$this

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