Spec-Zone.ru › Laravel 5.8

Mailable

class Mailable implements 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 Обработчики событий для сообщения.
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(Mailer $mailer)

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

mixed queue(Factory $queue)

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

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

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

string render()

Отобразить сообщение с помощью шаблона.

array|string buildView()

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

массив buildMarkdownView()

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

массив buildViewData()

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

строка 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)

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

$this 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)

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

$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 withSwiftMessage(callable $callback)

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

static void buildViewDataUsing(callable $callback)

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

$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(Mailer $mailer)

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

Параметры

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

string render()

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

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

string

Исключения

ReflectionException

protected array|string buildView()

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

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

array|string

Исключения

ReflectionException

protected array buildMarkdownView()

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

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

array

Исключения

ReflectionException

массив buildViewData()

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

Значение возвращаемого значения

массив

Исключения

ReflectionException

protected строка buildMarkdownText(Markdown $markdown, массив $data)

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

Параметры

Markdown $markdown
массив $data

Значение возвращаемого значения

строка

protected $this buildFrom(Message $message)

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

Параметры

Message $message

Значение возвращаемого значения

$this

protected $this buildRecipients(Message $message)

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

Параметры

Message $message

Значение возвращаемого значения

$this

protected $this buildSubject(Message $message)

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

Параметры

Message $message

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

$this

protected $this buildAttachments(Message $message)

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

Параметры

Message $message

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

$this

protected void buildDiskAttachments(Message $message)

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

Параметры

Message $message

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

void

protected $this runCallbacks(Message $message)

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

Параметры

Message $message

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

$this

$this locale(string $locale)

Установите язык сообщения.

Параметры

string $locale

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

$this

$this priority(int $level = 3)

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

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

Параметры

int $level

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

bool

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

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

Параметры

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

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

$this

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

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

Параметры

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

Значение возврата

bool

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

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

Параметры

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

Значение возврата

$this

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

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

Параметры

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

Значение возврата

bool

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

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

Параметры

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

Значение возврата

$this

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

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

Параметры

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

Значение результата

bool

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

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

Параметры

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

Значение результата

$this

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

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

Параметры

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

Значение результата

bool

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

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

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

Параметры

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

Значение результата

$this

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

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

Параметры

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

Значение возврата

array

protected object normalizeRecipient(mixed $recipient)

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

Параметры

mixed $recipient

Значение возврата

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 withSwiftMessage(callable $callback)

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

Параметры

callable $callback

Значение результата

$this

static void buildViewDataUsing(callable $callback)

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

Параметры

callable $callback

Значение результата

void

$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/5.8/Illuminate/Mail/Mailable.html

Spec-Zone.ru

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