Spec-Zone.ru › Laravel 11

Mailer

класс Mailer реализует Mailer, MailQueue (View source)

Черты

Macroable

Свойства

static protected array $macros

Зарегистрированные строковые макросы.

 из Macroable
protected string $name

Имя, настроенное для почтового отправления.
protected Factory $views

Экземпляр фабрики представлений.
protected TransportInterface $transport

Экземпляр Symfony Transport.
protected Dispatcher|null $events

Экземпляр диспетчера событий.
protected array $from

Глобальный адрес и имя отправителя.
protected array $replyTo

Глобальный адрес и имя ответа.
protected array $returnPath

Глобальный адрес возврата.
protected array $to

Глобальный адрес и имя получателя.
protected Factory $queue

Реализация фабрики очереди.

Методы

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

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

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

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

 из Macroable
static bool hasMacro(string $name)

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

 из Macroable
static void flushMacros()

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

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

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

 из Macroable
mixed __call(string $method, array $parameters)

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

 из Macroable
void __construct(string $name, Factory $views, TransportInterface $transport, Dispatcher|null $events = null)

Создать новый экземпляр Mailer.
void alwaysFrom(string $address, string|null $name = null)

Установить глобальный адрес и имя отправителя.
void alwaysReplyTo(string $address, string|null $name = null)

Установить глобальный адрес и имя ответа.
void alwaysReturnPath(string $address)

Установить глобальный адрес обратного пути.
void alwaysTo(string $address, string|null $name = null)

Установить глобальный адрес и имя получателя.
PendingMail to(mixed $users, string|null $name = null)

Начать процесс отправки экземпляра класса mailable.
PendingMail cc(mixed $users, string|null $name = null)

Начать процесс отправки экземпляра класса mailable.
PendingMail bcc(mixed $users, string|null $name = null)

Начать процесс отправки экземпляра класса mailable.
SentMessage|null html(string $html, mixed $callback)

Отправить новое сообщение только с HTML-частью.
SentMessage|null raw(string $text, mixed $callback)

Отправить новое сообщение только с необработанной текстовой частью.
SentMessage|null plain(string $view, array $data, mixed $callback)

Отправить новое сообщение только с простой частью.
string render(string|array $view, array $data = [])

Рендеринг заданного сообщения как представление.
string replaceEmbeddedAttachments(string $renderedView, array $attachments)

Заменить встроенные вложения изображений на необработанные, встроенные данные изображения для рендеринга в браузере.
SentMessage|null send(Mailable|string|array $view, array $data = [], Closure|string|null $callback = null)

Отправить новое сообщение, используя представление.
SentMessage|null sendMailable(Mailable $mailable)

Отправить заданное письмо.
SentMessage|null sendNow(Mailable|string|array $mailable, array $data = [], Closure|string|null $callback = null)

Синхронно отправить новое сообщение, используя представление.
array parseView(Closure|array|string $view)

Разбора заданного имени представления или массива.
void addContent(Message $message, string $view, string $plain, string $raw, array $data)

Добавить контент к заданному сообщению.
string renderView(Closure|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()

Создать новый экземпляр сообщения.
SentMessage|null sendSymfonyMessage(Email $message)

Отправить экземпляр Symfony Email.
bool shouldSendMessage(Email $message, array $data = [])

Определяет, можно ли отправить электронное письмо.
void dispatchSentEvent(SentMessage $message, array $data = [])

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

Получить экземпляр Symfony Transport.
Factory getViewFactory()

Получить экземпляр фабрики представлений.
void setSymfonyTransport(TransportInterface $transport)

Установить экземпляр Symfony Transport.
$this setQueue(Factory $queue)

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

Подробности

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

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

Параметры

string $name
object|callable $macro

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

void

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

Включить другой объект в класс.

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static void flushMacros()

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

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

void

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct(string $name, Factory $views, TransportInterface $transport, Dispatcher|null $events = null)

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

Параметры

string $name
Factory $views
TransportInterface $transport
Dispatcher|null $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 alwaysReturnPath(string $address)

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

Параметры

string $address

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

void

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

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

Параметры

string $address
string|null $name

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

void

PendingMail to(mixed $users, string|null $name = null)

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

Параметры

mixed $users
string|null $name

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

PendingMail

PendingMail cc(mixed $users, string|null $name = null)

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

Параметры

mixed $users
string|null $name

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

PendingMail

PendingMail bcc(mixed $users, string|null $name = null)

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

Параметры

mixed $users
string|null $name

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

PendingMail

SentMessage|null html(string $html, mixed $callback)

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

Параметры

string $html
mixed $callback

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

SentMessage|null

SentMessage|null raw(string $text, mixed $callback)

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

Параметры

string $text
mixed $callback

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

SentMessage|null

SentMessage|null plain(string $view, array $data, mixed $callback)

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

Параметры

string $view
array $data
mixed $callback

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

SentMessage|null

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

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

Параметры

string|array $view
array $data

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

string

protected string replaceEmbeddedAttachments(string $renderedView, array $attachments)

Заменить встроенные вложения изображений на необработанные данные встроенных изображений для рендеринга в браузере.

Параметры

string $renderedView
array $attachments

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

string

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

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

Параметры

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

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

SentMessage|null

protected SentMessage|null sendMailable(Mailable $mailable)

Отправить данное письмо.

Параметры

Mailable $mailable

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

SentMessage|null

SentMessage|null sendNow(Mailable|string|array $mailable, array $data = [], Closure|string|null $callback = null)

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

Параметры

Mailable|string|array $mailable
array $data
Closure|string|null $callback

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

SentMessage|null

protected array parseView(Closure|array|string $view)

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

Параметры

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

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

Параметры

Closure|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)

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

This method didn't match rest of framework's "onQueue" phrasing. Added "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 SentMessage|null sendSymfonyMessage(Email $message)

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

Параметры

Email $message

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

SentMessage|null

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

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

Параметры

Email $message
array $data

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

bool

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

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

Параметры

SentMessage $message
array $data

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

void

TransportInterface getSymfonyTransport()

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

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

TransportInterface

Factory getViewFactory()

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

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

Factory

void setSymfonyTransport(TransportInterface $transport)

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

Параметры

TransportInterface $transport

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

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/11.x/Illuminate/Mail/Mailer.html

Spec-Zone.ru

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