Mailable
класс Mailable реализует Mailable, Renderable (View source)
Черты
| Localizable |
Свойства
| string | $locale | Локаль сообщения. | |
| array | $from | Отправитель сообщения. | |
| array | $to | Получатели сообщения ("to"). | |
| array | $cc | Получатели сообщения ("cc"). | |
| array | $bcc | Получатели сообщения ("bcc"). | |
| array | $replyTo | Получатели сообщения ("reply to"). | |
| string | $subject | Тема сообщения. | |
| protected string | $markdown | Шаблон Markdown для сообщения (если применимо). | |
| protected string | $html | HTML-код для сообщения. | |
| string | $view | Представление для сообщения. | |
| string | $textView | Представление простого текста для сообщения. | |
| array | $viewData | Данные представления для сообщения. | |
| array | $attachments | Вложения для сообщения. | |
| array | $rawAttachments | Необработанные вложения для сообщения. | |
| array | $callbacks | Обратные вызовы для сообщения. |
Методы
| bool | withLocale(string $locale, Translator $translator, Closure $callback) Выполнить обратный вызов с заданным языковым стандартом. | из Localizable |
| void | send(Mailer $mailer) Отправить сообщение с помощью заданного почтового сервера. | |
| mixed | queue(Factory $queue) Поместить сообщение в очередь для отправки. | |
| mixed | later(DateTime|int $delay, Factory $queue) Доставить сообщение из очереди после заданной задержки. | |
| string | render() Отобразить письмо во view. | |
| 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) Добавить все вложения к сообщению. | |
| $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) Определить, установлен ли данный получатель в письме. | |
| $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 $name = null, array $options = []) Прикрепить файл к сообщению из хранилища. | |
| $this | attachFromStorageDisk(string $disk, string $path, string $name = null, array $options = []) Прикрепить файл к сообщению из хранилища. | |
| $this | attachData(string $data, string $name, array $options = []) Прикрепить данные из памяти в качестве вложения. | |
| $this | withSwiftMessage(callable $callback) Зарегистрировать обратный вызов, который будет вызван с экземпляром сообщения Swift. | |
| $this | __call(string $method, array $parameters) Динамически привязать параметры к сообщению. |
Подробности
bool withLocale(string $locale, Translator $translator, Closure $callback)
Выполнить обратный вызов с указанной локалью.
void send(Mailer $mailer)
Отправить сообщение с помощью указанного почтового отправителя.
mixed queue(Factory $queue)
Поместить сообщение в очередь для отправки.
mixed later(DateTime|int $delay, Factory $queue)
Доставить сообщение из очереди после указанной задержки.
string render()
Рендеринг письма во view.
protected array|string buildView()
Создать представление для сообщения.
protected array buildMarkdownView()
Создать представление Markdown для сообщения.
array buildViewData()
Создать данные для представления сообщения.
protected string buildMarkdownText(Markdown $markdown, array $data)
Создать текстовое представление для сообщения Markdown.
protected $this buildFrom(Message $message)
Добавить отправителя к сообщению.
protected $this buildRecipients(Message $message)
Добавить всех получателей к сообщению.
protected $this buildSubject(Message $message)
Установить тему сообщения.
protected $this buildAttachments(Message $message)
Добавить все вложения к сообщению.
protected $this runCallbacks(Message $message)
Выполнить обратные вызовы для сообщения.
$this locale(string $locale)
Установить локаль сообщения.
$this priority(int $level = 3)
Установить приоритет этого сообщения.
Значение представляет собой целое число, где 1 — наивысший приоритет, а 5 — наинизший.
$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)
Определить, установлен ли данный получатель в отправляемом письме.
protected $this setAddress(object|array|string $address, string|null $name = null, string $property = 'to')
Установить получателей сообщения.
Все получатели хранятся внутри как [['name' => ?, 'address' => ?]]
protected array addressesToArray(object|array|string $address, string|null $name)
Преобразовать заданные аргументы получателя в массив.
protected object normalizeRecipient(mixed $recipient)
Преобразовать заданного получателя в объект.
protected 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 $name = null, array $options = [])
Прикрепить файл к сообщению из хранилища.
$this attachFromStorageDisk(string $disk, string $path, string $name = null, array $options = [])
Прикрепить файл к сообщению из хранилища.
$this attachData(string $data, string $name, array $options = [])
Прикрепить данные в памяти в качестве вложения.
$this withSwiftMessage(callable $callback)
Зарегистрировать обратный вызов, который будет вызван с экземпляром сообщения Swift.
$this __call(string $method, array $parameters)
Динамически привязывать параметры к сообщению.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.6/Illuminate/Mail/Mailable.html
