Spec-Zone.ru › Laravel 10

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

Отправить указанное письмо.
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.
Фабрика getViewFactory()

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

Установить экземпляр транспорта Symfony.
$this setQueue(Фабрика $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, Фабрика $views, TransportInterface $transport, Диспетчер $events = null)

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

Параметры

string $name
Фабрика $views
TransportInterface $transport
Диспетчер $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

Ожидаемое письмо to(mixed $users, string|null $name = null)

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

Параметры

mixed $users
string|null $name

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

Ожидаемое письмо

Ожидаемое письмо cc(mixed $users, string|null $name = null)

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

Параметры

mixed $users
string|null $name

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

Ожидаемое письмо

Ожидаемое письмо bcc(mixed $users, string|null $name = null)

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

Параметры

mixed $users
string|null $name

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

Ожидаемое письмо

Отправленное сообщение|null html(string $html, mixed $callback)

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

Параметры

string $html
mixed $callback

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

Отправленное сообщение|null

Отправленное сообщение|null raw(string $text, mixed $callback)

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

Параметры

string $text
mixed $callback

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

Отправленное сообщение|null

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

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

Параметры

строка $view
массив $data
смешанный тип $callback

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

SentMessage|null

строка render(string|array $view, array $data = [])

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

Параметры

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

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

строка

protected строка replaceEmbeddedAttachments(string $renderedView, array $attachments)

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

Параметры

строка $renderedView
массив $attachments

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

строка

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

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

Параметры

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

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

SentMessage|null

protected SentMessage|null sendMailable(Mailable $mailable)

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

Параметры

Mailable $mailable

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

SentMessage|null

protected массив parseView(Closure|array|string $view)

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

Параметры

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

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

массив

Исключения

InvalidArgumentException

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

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

Параметры

Message $message
строка $view
строка $plain
строка $raw
массив $data

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

void

protected строка renderView(Closure|string $view, array $data)

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

Параметры

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

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

строка

protected void setGlobalToAndRemoveCcAndBcc(Message $message)

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

Параметры

Message $message

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

void

смешанный тип queue(Mailable|string|array $view, string|null $queue = null)

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

Параметры

Mailable|строка|массив $view
строка|null $queue

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

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

Исключения

InvalidArgumentException

смешанный тип onQueue(string $queue, Mailable $view)

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

Параметры

строка $queue
Mailable $view

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

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

смешанный тип queueOn(string $queue, Mailable $view)

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

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

Параметры

строка $queue
Mailable $view

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

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

смешанный тип later(DateTimeInterface|DateInterval|int $delay, Mailable|string|array $view, string|null $queue = null)

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

Параметры

DateTimeInterface|DateInterval|int $delay
Mailable|строка|массив $view
строка|null $queue

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

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

Исключения

InvalidArgumentException
END_OF_DOCUMENT_MARKER

смешанный laterOn(строка $queue, DateTimeInterface|DateInterval|целое $delay, Mailable $view)

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

Параметры

строка $queue
DateTimeInterface|DateInterval|целое $delay
Mailable $view

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

смешанный

защищенный Message createMessage()

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

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

Message

защищенный SentMessage|null sendSymfonyMessage(Email $message)

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

Параметры

Email $message

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

SentMessage|null

защищенный bool shouldSendMessage(Email $message, массив $data = [])

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

Параметры

Email $message
массив $data

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

bool

защищенный пусто dispatchSentEvent(SentMessage $message, массив $data = [])

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

Параметры

SentMessage $message
массив $data

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

пусто

TransportInterface getSymfonyTransport()

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

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

TransportInterface

Factory getViewFactory()

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

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

Factory

пусто setSymfonyTransport(TransportInterface $transport)

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

Параметры

TransportInterface $transport

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

пусто

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

Spec-Zone.ru

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