Mailer

class Mailer implements Mailer, MailQueue (View source)

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected string	$name	Имя, настроенное для почтового сервера.
protected Factory	$views	Экземпляр фабрики представлений.
protected Swift_Mailer	$swift	Экземпляр Swift Mailer.
protected Dispatcher\|null	$events	Экземпляр диспетчера событий.
protected array	$from	Глобальный адрес и имя отправителя.
protected array	$replyTo	Глобальный адрес и имя для ответа.
protected array	$returnPath	Глобальный адрес возврата.
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 void

flushMacros()

Очистить существующие макросы.

from Macroable

static mixed

__callStatic(string $method, array $parameters)

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

from Macroable

mixed

__call(string $method, array $parameters)

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

from Macroable

void

__construct(string $name, 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

alwaysReturnPath(string $address)

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

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

Поставить в очередь новое электронное письмо для отправки через (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)

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

static void flushMacros()

Очистить существующие макросы.

Return Value

void

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

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

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

Parameters

string	$name
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)

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

Parameters

string	$address
string\|null	$name

Return Value

void

void alwaysReturnPath(string $address)

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

Parameters

string

$address

Return Value

void

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

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

Parameters

string	$address
string\|null	$name

Return Value

void

PendingMail to(mixed $users)

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

Parameters

mixed

$users

Return Value

PendingMail

PendingMail cc(mixed $users)

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

Parameters

mixed

$users

Return Value

PendingMail

PendingMail bcc(mixed $users)

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

Parameters

mixed

$users

Return Value

PendingMail

void html(string $html, mixed $callback)

Отправить новое сообщение только с HTML частью.

Parameters

string	$html
mixed	$callback

Return Value

void

void raw(string $text, mixed $callback)

Отправить новое сообщение только с сырой текстовой частью.

Parameters

string	$text
mixed	$callback

Return Value

void

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

Отправить новое сообщение только с простой частью.

Parameters

string	$view
array	$data
mixed	$callback

Return Value

void

string render(string|array $view, array $data = [])

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

Parameters

string\|array	$view
array	$data

Return Value

string

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

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

Параметры

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

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

void

protected mixed sendMailable(Mailable $mailable)

Отправить заданный объект mailable.

Параметры

Mailable

$mailable

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

mixed

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 setGlobalToAndRemoveCcAndBcc(Message $message)

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

Параметры

Message

$message

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

void

mixed queue(Mailable|string|array $view, string|null $queue = null)

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

Параметры

Mailable\|string\|array	$view
string\|null	$queue

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

mixed

Исключения

InvalidArgumentException

mixed onQueue(string $queue, Mailable $view)

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

Параметры

string	$queue
Mailable	$view

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

mixed

mixed queueOn(string $queue, Mailable $view)

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

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

Параметры

string	$queue
Mailable	$view

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

mixed

mixed later(DateTimeInterface|DateInterval|int $delay, Mailable|string|array $view, string|null $queue = null)

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

Параметры

DateTimeInterface\|DateInterval\|int	$delay
Mailable\|string\|array	$view
string\|null	$queue

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

mixed

Исключения

InvalidArgumentException

mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, Mailable $view)

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

Параметры

string	$queue
DateTimeInterface\|DateInterval\|int	$delay
Mailable	$view

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

mixed

protected Message createMessage()

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

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

Message

protected int|null sendSwiftMessage(Swift_Message $message)

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

Параметры

Swift_Message

$message

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

int|null

protected bool shouldSendMessage(Swift_Message $message, array $data = [])

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

Параметры

Swift_Message	$message
array	$data

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

bool

END_OF_DOCUMENT_MARKER

protected void dispatchSentEvent(Message $message, array $data = [])

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

Параметры

Message	$message
массив	$data

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

void

protected void forceReconnection()

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

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

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

void

array failures()

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

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

массив

Swift_Mailer getSwiftMailer()

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

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

Swift_Mailer

Factory getViewFactory()

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

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

Factory

void setSwiftMailer(Swift_Mailer $swift)

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

Параметры

Swift_Mailer

$swift

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

void

$this setQueue(Factory $queue)

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

Параметры

Factory

$queue

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

$this

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