Spec-Zone.ru › Laravel 5.4

Почтовый клиент

класс Mailer реализует Mailer, MailQueue (Просмотреть исходный код)

Трейты

Macroable

Свойства

статический защищённый массив $macros Зарегистрированные строковые макросы. из Macroable
защищённый Factory $views Экземпляр фабрики представления.
защищённый Swift_Mailer $swift Экземпляр Swift Mailer.
защищённый Dispatcher|null $events Экземпляр диспетчера событий.
защищённый массив $from Глобальный адрес и имя отправителя.
защищённый массив $replyTo Глобальный адрес и имя для ответа.
защищённый массив $to Глобальный адрес и имя получателя.
защищённый Queue $queue Реализация очереди.
защищённый массив $failedRecipients Массив недоставленных получателей.

Методы

static void macro(string $name, callable $macro)

Зарегистрировать пользовательское макро.

from Macroable
static bool hasMacro(string $name)

Проверить, зарегистрировано ли макро.

from Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

from Macroable
mixed __call(string $method, array $parameters)

Динамически обработать вызовы к классу.

from Macroable
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)

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

PendingMail to(mixed $users)

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

PendingMail 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 sendMailable(Mailable $mailable)

Отправить указанное mailable.

array parseView(string|array $view)

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

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

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

string renderView(string $view, array $data)

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

void setGlobalTo(Message $message)

Установить глобальный адрес «получателю» в заданном сообщении.

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) секунд в заданную очередь.

Message createMessage()

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

void sendSwiftMessage(Swift_Message $message)

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

bool shouldSendMessage(Swift_Message $message)

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

void dispatchSentEvent(Message $message)

Отправить событие отправки сообщения.

void forceReconnection()

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

Factory getViewFactory()

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

Swift_Mailer getSwiftMailer()

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

array failures()

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

void setSwiftMailer(Swift_Mailer $swift)

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

$this setQueue(Factory $queue)

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

Details

static void macro(string $name, callable $macro)

Зарегистрировать пользовательское макро.

Parameters

string $name
callable $macro

Return Value

void

static bool hasMacro(string $name)

Проверить, зарегистрировано ли макро.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

смешанный тип __call(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Параметры

string $method
array $parameters

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

смешанный тип

Исключения

BadMethodCallException

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

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

Параметры

Factory $views
Swift_Mailer $swift
Dispatcher $events

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

void

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

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

Параметры

string $address
string|null $name

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

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

PendingMail to(mixed $users)

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

Параметры

mixed $users

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

PendingMail

PendingMail bcc(mixed $users)

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

Параметры

mixed $users

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

PendingMail

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

protected смешанный тип sendMailable(Mailable $mailable)

Отправить указанный mailable.

Параметры

Mailable $mailable

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

смешанный тип

protected array parseView(string|array $view)

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

Параметры

string|array $view

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

array

Исключения

InvalidArgumentException

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 string renderView(string $view, array $data)

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

Параметры

string $view
array $data

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

string

protected void setGlobalTo(Message $message)

Установить глобальный адрес "to" в заданном сообщении.

Параметры

Message $message

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

void

смешанный тип queue(string|array $view, array $data = [], Closure|string $callback = null, string $queue = null)

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

Параметры

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

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

смешанный тип

смешанный тип onQueue(string $queue, string|array $view, array $data, Closure|string $callback)

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

Параметры

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

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

смешанный тип

смешанный queueOn(строка $queue, строка|массив $view, массив $data, Closure|строка $callback)

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

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

Параметры

строка $queue
строка|массив $view
массив $data
Closure|строка $callback

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

смешанный

смешанный later(целое $delay, строка|массив $view, массив $data = [], Closure|строка $callback = null, строка $queue = null)

Очередь нового сообщения электронной почты для отправки через (n) секунд.

Параметры

целое $delay
строка|массив $view
массив $data
Closure|строка $callback
строка $queue

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

смешанный

смешанный laterOn(строка $queue, целое $delay, строка|массив $view, массив $data, Closure|строка $callback)

Очередь нового сообщения электронной почты для отправки через (n) секунд в заданной очереди.

Параметры

строка $queue
целое $delay
строка|массив $view
массив $data
Closure|строка $callback

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

смешанный

защищенное Сообщение createMessage()

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

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

Сообщение

защищенное пустое sendSwiftMessage(Swift_Message $message)

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

Параметры

Swift_Message $message

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

пустое

защищенное логическое shouldSendMessage(Swift_Message $message)

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

Параметры

Swift_Message $message

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

логическое

защищенное пустое dispatchSentEvent(Сообщение $message)

Отправить событие отправки сообщения.

Параметры

Сообщение $message

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

пустое

защищенное пустое forceReconnection()

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

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

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

пустое

Фабрика getViewFactory()

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

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

Фабрика

Swift_Mailer getSwiftMailer()

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

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

Swift_Mailer

массив failures()

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

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

массив

пустое setSwiftMailer(Swift_Mailer $swift)

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

Параметры

Swift_Mailer $swift

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

пустое

$this setQueue(Фабрика $queue)

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

Параметры

Фабрика $queue

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

$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

Spec-Zone.ru

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