Spec-Zone.ru › Laravel 9

Mailer

class Mailer implements Mailer, MailQueue (View source)

Свойства

Macroable

Свойства

static protected array $macros

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

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

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

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, TransportInterface $transport, Dispatcher $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)

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

PendingMail cc(mixed $users)

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

PendingMail bcc(mixed $users)

Начать процесс отправки экземпляра класса 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 = [])

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

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

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

SentMessage|null 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)

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

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 $events = null)

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

Параметры

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

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

Параметры

string $address

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

void

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

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

Параметры

string $address
string|null $name

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

void

PendingMail to(mixed $users)

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

Параметры

mixed $users

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

PendingMail

PendingMail cc(mixed $users)

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

Параметры

mixed $users

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

PendingMail

PendingMail bcc(mixed $users)

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

Параметры

mixed $users

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

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

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

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 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
массив $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/9.x/Illuminate/Mail/Mailer.html

Spec-Zone.ru

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