Spec-Zone.ru › Laravel 5.3

Mailer

class Mailer implements Mailer, MailQueue (View source)

Свойства

protected Factory $views Экземпляр фабрики представлений.
protected Swift_Mailer $swift Экземпляр Swift Mailer.
protected Dispatcher|null $events Экземпляр диспетчера событий.
protected array $from Глобальный адрес и имя отправителя.
protected array $replyTo Глобальный адрес и имя для ответа.
protected array $to Глобальный адрес и имя получателя.
protected Container $container Экземпляр контейнера IoC.
protected Queue $queue Реализация очереди.
protected array $failedRecipients Массив адресатов с ошибками доставки.

Методы

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

Создать новый экземпляр Mailer.

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

Установить глобальный адрес и имя от.

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

Установить глобальный адрес и имя ответа.

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

Установить глобальный адрес и имя получателя.

MailableMailer to(mixed $users)

Начать процесс отправки экземпляра класса mailable.

MailableMailer bcc(mixed $users)

Начать процесс отправки экземпляра класса mailable.

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

Отправить новое сообщение, когда есть только часть с текстом.

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

Отправить новое сообщение, когда есть только простая часть.

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

Отправить новое сообщение, используя представление.

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

Поместить новое электронное письмо в очередь для отправки.

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

Поместить новое электронное письмо в очередь для отправки в заданную очередь.

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

Поместить новое электронное письмо в очередь для отправки в заданную очередь.

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

Поместить новое электронное письмо в очередь для отправки через (n) секунд.

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

Поместить новое электронное письмо в очередь для отправки через (n) секунд в заданную очередь.

void forceReconnection()

Принудительно переподключиться к транспорту.

void addContent(Message $message, string $view, string $plain, string $raw, array $data)

Добавить содержимое в заданное сообщение.

array parseView(string|array $view)

Обработать указанное имя представления или массив.

void sendSwiftMessage(Swift_Message $message)

Отправить экземпляр Swift Message.

mixed callMessageBuilder(Closure|string $callback, Message $message)

Вызвать предоставленного билдера сообщений.

Message createMessage()

Создать новый экземпляр сообщения.

string getView(string $view, array $data)

Отобразить заданное представление.

Factory getViewFactory()

Получить экземпляр фабрики представлений.

Swift_Mailer getSwiftMailer()

Получить экземпляр Swift Mailer.

array failures()

Получить массив не удавшихся получателей.

void setSwiftMailer(Swift_Mailer $swift)

Установить экземпляр Swift Mailer.

$this setQueue(Factory $queue)

Установить экземпляр менеджера очереди.

void setContainer(Container $container)

Установить экземпляр контейнера IoC.

Details

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

Создать новый экземпляр Mailer.

Parameters

Factory $views
Swift_Mailer $swift
Dispatcher $events

Return Value

void

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

Установить глобальный адрес и имя от.

Parameters

string $address
string|null $name

Return Value

void

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

Установить глобальный адрес и имя ответа.

Параметры

string $address
string|null $name

Значение возврата

void

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

Установить глобальный адрес и имя получателя.

Параметры

string $address
string|null $name

Значение возврата

void

MailableMailer to(mixed $users)

Начать процесс отправки экземпляра класса mailable.

Параметры

mixed $users

Значение возврата

MailableMailer

MailableMailer bcc(mixed $users)

Начать процесс отправки экземпляра класса mailable.

Параметры

mixed $users

Значение возврата

MailableMailer

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

Отправить новое сообщение, содержащее только сырой текст.

Параметры

string $text
Closure|string $callback

Значение возврата

int

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

Отправить новое сообщение, содержащее только текст.

Параметры

string $view
array $data
mixed $callback

Значение возврата

void

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

Отправить новое сообщение, используя представление.

Параметры

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

Значение возврата

void

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

Поместить новое электронное письмо в очередь для отправки.

Параметры

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

Значение возврата

mixed

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

Поместить новое электронное письмо в очередь для отправки в заданную очередь.

Параметры

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

Значение возврата

mixed

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

Поместить новое электронное письмо в очередь для отправки в заданную очередь.

Этот метод не соответствовал остальной фразеологии фреймворка "onQueue". Добавлено "onQueue".

Параметры

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

Значение возврата

mixed

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

Поместить новое электронное письмо в очередь для отправки через (n) секунд.

Параметры

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

Значение возврата

mixed

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

Поместить новое электронное письмо в очередь для отправки через (n) секунд в заданную очередь.

Параметры

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

Значение возврата

mixed

protected void forceReconnection()

Вынудительно переподключиться к транспорту.

Это предотвратит ошибки в ситуациях с daemon-очереди.

Значение возврата

void

protected void addContent(Message $message, string $view, string $plain, string $raw, array $data)

Добавить содержимое в заданное сообщение.

Параметры

Message $message
string $view
string $plain
string $raw
array $data

Значение возврата

void

protected array parseView(string|array $view)

Разбрать заданное имя представления или массив.

Параметры

string|array $view

Значение возврата

array

Исключения

InvalidArgumentException

protected void sendSwiftMessage(Swift_Message $message)

Отправить экземпляр Swift Message.

Параметры

Swift_Message $message

Значение возврата

void
END_OF_DOCUMENT_MARKER

protected mixed callMessageBuilder(Closure|string $callback, Message $message)

Вызвать предоставленный билдер сообщений.

Параметры

Closure|string $callback
Message $message

Возвращаемое значение

mixed

Исключения

InvalidArgumentException

protected Message createMessage()

Создать новый экземпляр сообщения.

Возвращаемое значение

Message

protected string getView(string $view, array $data)

Отобразить заданный вид.

Параметры

string $view
array $data

Возвращаемое значение

string

Factory getViewFactory()

Получить экземпляр фабрики представлений.

Возвращаемое значение

Factory

Swift_Mailer getSwiftMailer()

Получить экземпляр Swift Mailer.

Возвращаемое значение

Swift_Mailer

array failures()

Получить массив неудачных получателей.

Возвращаемое значение

array

void setSwiftMailer(Swift_Mailer $swift)

Установить экземпляр Swift Mailer.

Параметры

Swift_Mailer $swift

Возвращаемое значение

void

$this setQueue(Factory $queue)

Установить экземпляр диспетчера очереди.

Параметры

Factory $queue

Возвращаемое значение

$this

void setContainer(Container $container)

Установить экземпляр контейнера IoC.

Параметры

Container $container

Возвращаемое значение

void

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API