Spec-Zone.ru › Laravel 8

Mailable

класс Mailable реализует Mailable, Renderable (Просмотр исходного кода)

Свойства

Conditionable
ForwardsCalls
Localizable

Свойства

string $locale

Локаль сообщения.
array $from

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

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

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

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

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

Тема сообщения.
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

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

Отрендеренные представления почтового сообщения для тестирования/утверждений.
static callable $viewDataCallback

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

Методы

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

Примените обратный вызов, если заданное «значение» истинно.

 из Conditionable
$this|mixed unless(mixed $value, callable $callback, callable|null $default = null)

Примените обратный вызов, если заданное «значение» ложно.

 из Conditionable
mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

 из ForwardsCalls
mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода заданному объекту, вернув $this, если переадресованный вызов вернул себя.

 из ForwardsCalls
static void throwBadMethodCallException(string $method)

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

 из ForwardsCalls
mixed withLocale(string $locale, Closure $callback)

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

 из 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)

Определить, установлен ли указанный 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 assertSeeInHtml(string $string)

Утверждение, что данный текст присутствует в HTML-теле сообщения по электронной почте.
$this assertDontSeeInHtml(string $string)

Утверждение, что данного текста нет в HTML-теле сообщения по электронной почте.
$this assertSeeInText(string $string)

Утверждение, что данный текст присутствует в текстовом теле сообщения по электронной почте.
$this assertDontSeeInText(string $string)

Утверждение, что данного текста нет в текстовом теле сообщения по электронной почте.
array renderForAssertions()

Отображение HTML- и текстовой версий рассылаемого сообщения в представлениях для утверждений.
$this mailer(string $mailer)

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

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

Регистрация обратного вызова, который будет вызван при построении данных представления.
$this __call(string $method, array $parameters)

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

Подробности

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

Примените обратный вызов, если заданное «значение» истинно.

Параметры

mixed $value
callable $callback
callable|null $default

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

$this|mixed

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

Примените обратный вызов, если заданное «значение» ложно.

Параметры

mixed $value
callable $callback
callable|null $default

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

$this|mixed

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

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

Параметры

mixed $object
string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

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

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

Параметры

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
END_OF_DOCUMENT_MARKER

строка render()

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

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

строка

Исключения

ReflectionException

protected массив|строка buildView()

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

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

массив|строка

Исключения

ReflectionException

protected массив buildMarkdownView()

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

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

массив

Исключения

ReflectionException

массив buildViewData()

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

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

массив

Исключения

ReflectionException

protected строка buildMarkdownText(Markdown $markdown, array $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

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

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

Параметры

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

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

Mailable

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 assertSeeInHtml(string $string)

Утверждение, что заданный текст присутствует в HTML теле электронного письма.

Параметры

string $string

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

$this

$this assertDontSeeInHtml(string $string)

Утверждение, что указанный текст отсутствует в теле HTML-части электронного письма.

Параметры

string $string

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

$this

$this assertSeeInText(string $string)

Утверждение, что указанный текст присутствует в текстовом теле электронного письма.

Параметры

string $string

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

$this

$this assertDontSeeInText(string $string)

Утверждение, что указанный текст отсутствует в текстовом теле электронного письма.

Параметры

string $string

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

$this

protected array renderForAssertions()

Отображение HTML и текстовой версии mailable в представления для утверждений.

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

array

Исключения

ReflectionException

$this mailer(string $mailer)

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

Параметры

string $mailer

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

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

Spec-Zone.ru

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