Spec-Zone.ru › Laravel 6

Mailable

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

Методы

ForwardsCalls
Localizable

Свойства

строка $locale

Язык сообщения.
массив $from

От кого отправлено сообщение.
массив $to

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

Получатели сообщения (копия).
массив $bcc

Получатели сообщения (скрытая копия).
массив $replyTo

Получатели ответа.
строка $subject

Тема сообщения.
защищенная строка $markdown

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

HTML для сообщения.
строка $view

Используемый вид для сообщения.
строка $textView

Простой текст для сообщения.
массив $viewData

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

Вложения к сообщению.
массив $rawAttachments

Необработанные вложения к сообщению.
массив $diskAttachments

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

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

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

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

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)

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

Параметры

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)

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

Параметры

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/6.x/Illuminate/Mail/Mailable.html

Spec-Zone.ru

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