Spec-Zone.ru › Laravel 5.7

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
bool withLocale(string $locale, Closure $callback)

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

 from Localizable
void send(Mailer $mailer)

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

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

Доставить сообщение в очереди через заданную задержку.
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)

Определить, установлен ли указанный получатель в почтовом сообщении.
$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.
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

bool withLocale(string $locale, Closure $callback)

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

Параметры

string $locale
Closure $callback

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

bool

void send(Mailer $mailer)

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

Параметры

Mailer $mailer

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

void

mixed queue(Factory $queue)

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

Параметры

Factory $queue

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

mixed

mixed later(DateTime|int $delay, Factory $queue)

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

Параметры

DateTime|int $delay
Factory $queue

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

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)

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

Параметры

Message $message

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

$this

protected $this buildAttachments(Message $message)

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

Параметры

Message $message

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

$this

protected void buildDiskAttachments(Message $message)

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

Параметры

Message $message

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

void
END_OF_DOCUMENT_MARKER

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 $name = null, array $options = [])

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

Параметры

string $path
string $name
array $options

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

$this

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

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

Параметры

string $disk
string $path
string $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.7/Illuminate/Mail/Mailable.html

Spec-Zone.ru

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