Mailer
класс Mailer реализует Mailer, MailQueue (View source)
Черты
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected Factory | $views | Экземпляр фабрики представлений. | |
| protected Swift_Mailer | $swift | Экземпляр Swift Mailer. | |
| protected Dispatcher|null | $events | Экземпляр диспетчера событий. | |
| protected array | $from | Глобальный адрес и имя отправителя. | |
| protected array | $replyTo | Глобальный адрес и имя ответа. | |
| protected array | $to | Глобальный адрес и имя получателя. | |
| protected Factory | $queue | Реализация фабрики очереди. | |
| protected array | $failedRecipients | Массив неудачных получателей. |
Методы
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Включить другой объект в класс. | 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 | cc(mixed $users)
Начать процесс отправки экземпляра класса mailable. | |
| PendingMail | bcc(mixed $users)
Начать процесс отправки экземпляра класса mailable. | |
| void | html(string $html, mixed $callback)
Отправить новое сообщение только с HTML-частью. | |
| void | raw(string $text, mixed $callback)
Отправить новое сообщение только с необработанной текстовой частью. | |
| void | plain(string $view, array $data, mixed $callback)
Отправить новое сообщение только с простой частью. | |
| string | render(string|array $view, array $data = [])
Отобразить данное сообщение как представление. | |
| void | send(Mailable|string|array $view, array $data = [], Closure|string|null $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 | setGlobalToAndRemoveCcAndBcc(Message $message)
Установить глобальный адрес "to" в заданном сообщении. | |
| mixed | queue(Mailable|string|array $view, string|null $queue = null)
Поставить в очередь новое электронное письмо для отправки. | |
| mixed | onQueue(string $queue, Mailable $view)
Поставить в очередь новое электронное письмо для отправки в заданную очередь. | |
| mixed | queueOn(string $queue, Mailable $view)
Поставить в очередь новое электронное письмо для отправки в заданную очередь. | |
| mixed | later(DateTimeInterface|DateInterval|int $delay, Mailable|string|array $view, string|null $queue = null)
Поставить в очередь новое электронное письмо для отправки через (n) секунд. | |
| mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, Mailable $view)
Поставить в очередь новое электронное письмо для отправки через (n) секунд в заданную очередь. | |
| Message | createMessage()
Создать новый экземпляр сообщения. | |
| int|null | sendSwiftMessage(Swift_Message $message)
Отправить экземпляр Swift Message. | |
| bool | shouldSendMessage(Swift_Message $message, array $data = [])
Определяет, можно ли отправить сообщение. | |
| void | dispatchSentEvent(Message $message, array $data = [])
Отправить событие отправки сообщения. | |
| void | forceReconnection()
Принудительно подключить транспорт. | |
| array | failures()
Получить массив неудачных получателей. | |
| Swift_Mailer | getSwiftMailer()
Получить экземпляр Swift Mailer. | |
| Factory | getViewFactory()
Получить экземпляр фабрики представлений. | |
| void | setSwiftMailer(Swift_Mailer $swift)
Установить экземпляр Swift Mailer. | |
| $this | setQueue(Factory $queue)
Установить экземпляр менеджера очереди. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос.
static void mixin(object $mixin, bool $replace = true)
Включить другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирован ли макрос.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
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 cc(mixed $users)
Начинает процесс отправки экземпляра класса mailable.
PendingMail bcc(mixed $users)
Начинает процесс отправки экземпляра класса mailable.
void html(string $html, mixed $callback)
Отправляет новое сообщение только с HTML-частью.
void raw(string $text, mixed $callback)
Отправляет новое сообщение только с простой текстовой частью.
void plain(string $view, array $data, mixed $callback)
Отправляет новое сообщение только с простой частью.
string render(string|array $view, array $data = [])
Рендерит данное сообщение как представление.
void send(Mailable|string|array $view, array $data = [], Closure|string|null $callback = null)
Отправляет новое сообщение, используя представление.
protected mixed sendMailable(Mailable $mailable)
Отправляет данное письмо.
protected array parseView(string|array $view)
Разбор заданного имени представления или массива.
protected void addContent(Message $message, string $view, string $plain, string $raw, array $data)
Добавление контента к заданному сообщению.
protected string renderView(string $view, array $data)
Рендеринг заданного представления.
protected void setGlobalToAndRemoveCcAndBcc(Message $message)
Установка глобального адреса "to" в заданном сообщении.
mixed queue(Mailable|string|array $view, string|null $queue = null)
Постановка в очередь нового сообщения электронной почты для отправки.
mixed onQueue(string $queue, Mailable $view)
Постановка в очередь нового сообщения электронной почты для отправки в заданную очередь.
mixed queueOn(string $queue, Mailable $view)
Постановка в очередь нового сообщения электронной почты для отправки в заданную очередь.
This method didn't match rest of framework's "onQueue" phrasing. Added "onQueue".
mixed later(DateTimeInterface|DateInterval|int $delay, Mailable|string|array $view, string|null $queue = null)
Постановка в очередь нового сообщения электронной почты для отправки через (n) секунд.
mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, Mailable $view)
Постановка в очередь нового сообщения электронной почты для отправки через (n) секунд в заданную очередь.
protected Message createMessage()
Создание нового экземпляра сообщения.
protected int|null sendSwiftMessage(Swift_Message $message)
Отправка экземпляра Swift Message.
protected bool shouldSendMessage(Swift_Message $message, array $data = [])
Определяет, можно ли отправить сообщение.
protected void dispatchSentEvent(Message $message, array $data = [])
Отправка события отправки сообщения.
protected void forceReconnection()
Принудительное переподключение транспорта.
Это предотвратит ошибки в ситуациях с демоном очереди.
array failures()
Получение массива неудачных получателей.
Swift_Mailer getSwiftMailer()
Получение экземпляра Swift Mailer.
Factory getViewFactory()
Получить экземпляр фабрики представлений.
void setSwiftMailer(Swift_Mailer $swift)
Установить экземпляр Swift Mailer.
$this setQueue(Factory $queue)
Установить экземпляр менеджера очереди.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Mail/Mailer.html
