Spec-Zone.ru › Laravel 7

Mailable

класс Mailable реализует Mailable, Renderable (View source)

Свойства

ForwardsCalls
Localizable

Свойства

string $locale

Язык сообщения.
array $from

Отправитель сообщения.
array $to

Получатели сообщения.
array $cc

Получатели сообщения с копией.
array $bcc

Получатели сообщения с скрытой копией.
array $replyTo

Получатели ответа на сообщение.
string $subject

Тема сообщения.
protected string $markdown

Шаблон Markdown для сообщения (если применимо).
protected string $html

HTML для использования в сообщении.
string $view

Вид для использования в сообщении.
string $textView

Простой текстовый вид для использования в сообщении.
array $viewData

Данные для представления сообщения.
array $attachments

Вложения для сообщения.
array $rawAttachments

Необработанные вложения для сообщения.
array $diskAttachments

Вложения из хранилища.
array $callbacks

Обработчики событий для сообщения.
string|null $theme

Имя темы, которая должна использоваться при форматировании сообщения.
string $mailer

Имя почтового сервера, который должен отправить сообщение.
static callable $viewDataCallback

Обработчик, который должен быть вызван при построении данных представления.

Методы

mixed forwardCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода заданному объекту.

 from ForwardsCalls
static void throwBadMethodCallException(string $method)

Выбросить исключение плохого вызова метода для заданного метода.

 from ForwardsCalls
mixed withLocale(string $locale, Closure $callback)

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

 from Localizable
void send(Factory|Mailer $mailer)

Отправить сообщение с помощью заданного почтового сервера.
mixed queue(Factory $queue)

Поместить сообщение в очередь для отправки.
mixed later(DateTimeInterface|DateInterval|int $delay, Factory $queue)

Отправить сообщение в очереди после заданной задержки.
mixed newQueuedJob()

Создать экземпляр задания отправки по очереди.
string render()

Отобразить отправительское письмо в представлении.
array|string buildView()

Создать представление для сообщения.
array buildMarkdownView()

Создать представление Markdown для сообщения.
array buildViewData()

Создать данные представления для сообщения.
string buildMarkdownText(Markdown $markdown, array $data)

Создать текстовое представление для сообщения Markdown.
$this buildFrom(Message $message)

Добавить отправителя к сообщению.
$this buildRecipients(Message $message)

Добавить всех получателей к сообщению.
$this buildSubject(Message $message)

Установить тему сообщения.
$this buildAttachments(Message $message)

Добавить все вложения к сообщению.
void buildDiskAttachments(Message $message)

Добавить все вложения из хранилища к сообщению.
$this runCallbacks(Message $message)

Выполнить обратные вызовы для сообщения.
$this locale(string $locale)

Установить язык сообщения.
$this priority(int $level = 3)

Установить приоритет этого сообщения.
$this from(object|array|string $address, string|null $name = null)

Установить отправителя сообщения.
bool hasFrom(object|array|string $address, string|null $name = null)

Определить, установлен ли данный получатель в отправительском письме.
$this to(object|array|string $address, string|null $name = null)

Установить получателей сообщения.
bool hasTo(object|array|string $address, string|null $name = null)

Определить, установлен ли данный получатель в отправительском письме.
Mailable cc(object|array|string $address, string|null $name = null)

Установить получателей сообщения.
bool hasCc(object|array|string $address, string|null $name = null)

Определить, установлен ли данный получатель в отправительском письме.
$this bcc(object|array|string $address, string|null $name = null)

Установить получателей сообщения.
bool hasBcc(object|array|string $address, string|null $name = null)

Определить, установлен ли данный получатель в отправительском письме.
$this replyTo(object|array|string $address, string|null $name = null)

Установить адрес ответа сообщения.
bool hasReplyTo(object|array|string $address, string|null $name = null)

Определить, установлен ли данный адрес ответа в отправительском письме.
$this setAddress(object|array|string $address, string|null $name = null, string $property = 'to')

Установить получателей сообщения.
array addressesToArray(object|array|string $address, string|null $name)

Преобразовать заданные аргументы получателей в массив.
object normalizeRecipient(mixed $recipient)

Преобразовать заданного получателя в объект.
bool hasRecipient(object|array|string $address, string|null $name = null, string $property = 'to')

Определить, установлен ли данный получатель в отправительском письме.
$this subject(string $subject)

Установить тему сообщения.
$this markdown(string $view, array $data = [])

Установить шаблон Markdown для сообщения.
$this view(string $view, array $data = [])

Установить представление и данные представления для сообщения.
$this html(string $html)

Установить отформатированный HTML-контент для сообщения.
$this text(string $textView, array $data = [])

Установить простое текстовое представление для сообщения.
$this with(string|array $key, mixed $value = null)

Установить данные представления для сообщения.
$this attach(string $file, array $options = [])

Прикрепить файл к сообщению.
$this attachFromStorage(string $path, string|null $name = null, array $options = [])

Прикрепить файл из хранилища к сообщению.
$this attachFromStorageDisk(string $disk, string $path, string|null $name = null, array $options = [])

Прикрепить файл к сообщению из хранилища.
$this attachData(string $data, string $name, array $options = [])

Прикрепить данные из памяти как вложение.
$this mailer(string $mailer)

Указать имя почтового сервера, который должен отправить сообщение.
$this withSwiftMessage(callable $callback)

Зарегистрировать обратный вызов, который будет вызван с экземпляром Swift-сообщения.
static void buildViewDataUsing(callable $callback)

Зарегистрировать обратный вызов, который будет вызван при построении данных для представления.
mixed|$this when(mixed $value, callable $callback, mixed $default = null)

Применить изменения сообщения обратного вызова, если заданное «значение» истинно.
$this __call(string $method, array $parameters)

Динамически привязать параметры к сообщению.

Подробности

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода заданному объекту.

Параметры

mixed $object
string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Вызвать исключение плохого вызова метода для данного метода.

Параметры

string $method

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

void

Исключения

BadMethodCallException

mixed withLocale(string $locale, Closure $callback)

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

Параметры

string $locale
Closure $callback

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

mixed

void send(Factory|Mailer $mailer)

Отправить сообщение с помощью данного почтового сервера.

Параметры

Factory|Mailer $mailer

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

void

mixed queue(Factory $queue)

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

Параметры

Factory $queue

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

mixed

mixed later(DateTimeInterface|DateInterval|int $delay, Factory $queue)

Доставить сообщение в очереди после заданной задержки.

Параметры

DateTimeInterface|DateInterval|int $delay
Factory $queue

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

mixed

protected mixed newQueuedJob()

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

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

mixed

string render()

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

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

string

Исключения

ReflectionException

protected array|string buildView()

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

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

array|string

Исключения

ReflectionException

protected array buildMarkdownView()

Построить представление Markdown для сообщения.

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

array

Исключения

ReflectionException

array buildViewData()

Построить данные представления для сообщения.

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

array

Исключения

ReflectionException

protected string buildMarkdownText(Markdown $markdown, array $data)

Построить текстовое представление для сообщения Markdown.

Параметры

Markdown $markdown
array $data

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

string

protected $this buildFrom(Message $message)

Добавить отправителя к сообщению.

Параметры

Message $message

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

$this

protected $this buildRecipients(Message $message)

Добавить всех получателей к сообщению.

Параметры

Message $message

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

$this

protected $this buildSubject(Message $message)

Установите тему сообщения.

Parameters

Message $message

Return Value

$this

protected $this buildAttachments(Message $message)

Добавьте все вложения к сообщению.

Parameters

Message $message

Return Value

$this

protected void buildDiskAttachments(Message $message)

Добавьте все вложения из хранилища к сообщению.

Parameters

Message $message

Return Value

void

protected $this runCallbacks(Message $message)

Выполните обратные вызовы для сообщения.

Parameters

Message $message

Return Value

$this

$this locale(string $locale)

Установите локаль сообщения.

Parameters

string $locale

Return Value

$this

$this priority(int $level = 3)

Установите приоритет этого сообщения.

Значение — целое число, где 1 — наивысший приоритет, а 5 — наименьший.

Parameters

int $level

Return Value

$this

$this from(object|array|string $address, string|null $name = null)

Установите отправителя сообщения.

Parameters

object|array|string $address
string|null $name

Return Value

$this

bool hasFrom(object|array|string $address, string|null $name = null)

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

Parameters

object|array|string $address
string|null $name

Return Value

bool

$this to(object|array|string $address, string|null $name = null)

Установите получателей сообщения.

Parameters

object|array|string $address
string|null $name

Return Value

$this

bool hasTo(object|array|string $address, string|null $name = null)

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

Parameters

object|array|string $address
string|null $name

Return Value

bool

Mailable cc(object|array|string $address, string|null $name = null)

Установите получателей сообщения.

Parameters

object|array|string $address
string|null $name

Return Value

Mailable

bool hasCc(object|array|string $address, string|null $name = null)

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

Parameters

object|array|string $address
string|null $name

Return Value

bool

$this bcc(object|array|string $address, string|null $name = null)

Установите получателей сообщения.

Parameters

object|array|string $address
string|null $name

Return Value

$this

bool hasBcc(object|array|string $address, string|null $name = null)

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

Parameters

object|array|string $address
string|null $name

Return Value

bool

$this replyTo(object|array|string $address, string|null $name = null)

Установите адрес "ответ на" сообщения.

Parameters

object|array|string $address
string|null $name

Return Value

$this

bool hasReplyTo(object|array|string $address, string|null $name = null)

Определите, установлен ли данный replyTo в отправляемом сообщении.

Parameters

object|array|string $address
string|null $name

Return Value

bool

protected $this setAddress(object|array|string $address, string|null $name = null, string $property = 'to')

Установите получателей сообщения.

Все получатели хранятся внутри как [['name' => ?, 'address' => ?]]

Parameters

object|array|string $address
string|null $name
string $property

Return Value

$this

protected array addressesToArray(object|array|string $address, string|null $name)

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

Parameters

object|array|string $address
string|null $name

Return Value

array

protected object normalizeRecipient(mixed $recipient)

Преобразуйте указанного получателя в объект.

Parameters

mixed $recipient

Return Value

object

protected bool hasRecipient(object|array|string $address, string|null $name = null, string $property = 'to')

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

Параметры

object|array|string $address
string|null $name
string $property

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

bool

$this subject(string $subject)

Установить тему сообщения.

Параметры

string $subject

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

$this

$this markdown(string $view, array $data = [])

Установить шаблон Markdown для сообщения.

Параметры

string $view
array $data

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

$this

$this view(string $view, array $data = [])

Установить представление и данные представления для сообщения.

Параметры

string $view
array $data

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

$this

$this html(string $html)

Установить отформатированный HTML-контент сообщения.

Параметры

string $html

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

$this

$this text(string $textView, array $data = [])

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

Параметры

string $textView
array $data

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

$this

$this with(string|array $key, mixed $value = null)

Установить данные представления для сообщения.

Параметры

string|array $key
mixed $value

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

$this

$this attach(string $file, array $options = [])

Прикрепить файл к сообщению.

Параметры

string $file
array $options

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

$this

$this attachFromStorage(string $path, string|null $name = null, array $options = [])

Прикрепить файл к сообщению из хранилища.

Параметры

string $path
string|null $name
array $options

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

$this

$this attachFromStorageDisk(string $disk, string $path, string|null $name = null, array $options = [])

Прикрепить файл к сообщению из хранилища.

Параметры

string $disk
string $path
string|null $name
array $options

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

$this

$this attachData(string $data, string $name, array $options = [])

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

Параметры

string $data
string $name
array $options

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

$this

$this mailer(string $mailer)

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

Параметры

string $mailer

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

$this

$this withSwiftMessage(callable $callback)

Зарегистрировать обратный вызов, который будет вызван с экземпляром Swift-сообщения.

Параметры

callable $callback

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

$this

static void buildViewDataUsing(callable $callback)

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

Параметры

callable $callback

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

void

mixed|$this when(mixed $value, callable $callback, mixed $default = null)

Применить изменения сообщения обратного вызова, если заданное "значение" истинно.

Параметры

mixed $value
callable $callback
mixed $default

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

mixed|$this

$this __call(string $method, array $parameters)

Динамически привязать параметры к сообщению.

Параметры

string $method
array $parameters

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

$this

Исключения

BadMethodCallException

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

Spec-Zone.ru

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