Mailable
класс Mailable реализует Mailable, Renderable (View source)
Свойства
| Conditionable | |
| ForwardsCalls | |
| Localizable | |
| Macroable |
Свойства
| static protected массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| строка | $locale | Язык сообщения. | |
| массив | $from | Отправитель сообщения. | |
| массив | $to | Получатели сообщения. | |
| массив | $cc | Получатели сообщения с копией. | |
| массив | $bcc | Получатели сообщения с скрытой копией. | |
| массив | $replyTo | Получатели ответа на сообщение. | |
| строка | $subject | Тема сообщения. | |
| строка | $markdown | Шаблон Markdown для сообщения (если применимо). | |
| protected строка | $html | HTML для сообщения. | |
| строка | $view | Используемый вид для сообщения. | |
| строка | $textView | Простой текстовый вид для сообщения. | |
| массив | $viewData | Данные для представления сообщения. | |
| массив | $attachments | Вложения к сообщению. | |
| массив | $rawAttachments | Необработанные вложения к сообщению. | |
| массив | $diskAttachments | Вложения из хранилища. | |
| protected массив | $tags | Теги сообщения. | |
| protected массив | $metadata | Метаданные сообщения. | |
| массив | $callbacks | Обработчики событий сообщения. | |
| строка|null | $theme | Имя темы, которая должна быть использована при форматировании сообщения. | |
| строка | $mailer | Имя почтового сервера, который должен отправить сообщение. | |
| protected массив | $assertionableRenderStrings | Отрендеренные представления mailable для тестирования/утверждений. | |
| static вызываемая функция | $viewDataCallback | Обработчик, который должен быть вызван при построении данных представления. |
Методы
| $this|TWhenReturnType | when($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное «значение» истинно (или разрешается до истинного). | из Conditionable |
| $this|TUnlessReturnType | unless($value = null, callable $callback = null, callable $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 |
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос. | из Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | из Macroable |
| static bool | hasMacro(string $name)
Проверяет, зарегистрирован ли макрос. | из Macroable |
| static void | flushMacros()
Очистить существующие макросы. | из Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы класса. | из Macroable |
| $this | __call(string $method, array $parameters)
Динамически привязывать параметры к сообщению. | |
| SentMessage|null | send(Factory|Mailer $mailer)
Отправить сообщение с помощью указанного почтового сервера. | |
| mixed | queue(Factory $queue)
Поместить сообщение в очередь для отправки. | |
| mixed | later(DateTimeInterface|DateInterval|int $delay, Factory $queue)
Доставить сообщение в очереди через (n) секунд. | |
| mixed | newQueuedJob()
Создать экземпляр задачи для отправки в очереди. | |
| string | render()
Отобразить отправляемое сообщение в виде представления. | |
| array|string | buildView()
Создать представление для сообщения. | |
| array | buildMarkdownView()
Создать представление Markdown для сообщения. | |
| array | buildViewData()
Создать данные представления для сообщения. | |
| Closure | buildMarkdownHtml(array $viewData)
Создать HTML-представление для сообщения Markdown. | |
| Closure | buildMarkdownText(array $viewData)
Создать текстовое представление для сообщения Markdown. | |
| Markdown | markdownRenderer()
Разрешает экземпляр Markdown с темой почты. | |
| $this | buildFrom(Message $message)
Добавить отправителя в сообщение. | |
| $this | buildRecipients(Message $message)
Добавить всех получателей в сообщение. | |
| $this | buildSubject(Message $message)
Установить тему для сообщения. | |
| $this | buildAttachments(Message $message)
Добавить все вложения к сообщению. | |
| void | buildDiskAttachments(Message $message)
Добавить все вложения с диска к сообщению. | |
| $this | buildTags(Message $message)
Добавить все определенные теги в сообщение. | |
| $this | buildMetadata(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)
Установить тему сообщения. | |
| bool | hasSubject(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|Attachable|Attachment $file, array $options = [])
Прикрепить файл к сообщению. | |
| $this | attachMany(array $files)
Прикрепить несколько файлов к сообщению. | |
| bool | hasAttachment(string|Attachable|Attachment $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 = [])
Прикрепить файл к сообщению из хранилища. | |
| bool | hasAttachmentFromStorage(string $path, string|null $name = null, array $options = [])
Определить, имеет ли отправляемое сообщение данное вложение из хранилища. | |
| bool | hasAttachmentFromStorageDisk(string $disk, string $path, string|null $name = null, array $options = [])
Определить, имеет ли отправляемое сообщение данное вложение из определенного диска хранилища. | |
| $this | attachData(string $data, string $name, array $options = [])
Прикрепить данные из памяти в качестве вложения. | |
| bool | hasAttachedData(string $data, string $name, array $options = [])
Определить, имеет ли отправляемое сообщение данные в качестве вложения. | |
| $this | tag(string $value)
Добавить заголовок тега к сообщению, если это поддерживается базовым транспортом. | |
| bool | hasTag(string $value)
Определить, имеет ли отправляемое сообщение данный тег. | |
| $this | metadata(string $key, string $value)
Добавить заголовок метаданных к сообщению, если это поддерживается базовым транспортом. | |
| bool | hasMetadata(string $key, string $value)
Определить, имеет ли отправляемое сообщение данные метаданные. | |
| $this | assertFrom(object|array|string $address, string|null $name = null)
Утверждать, что отправляемое сообщение от указанного адреса. | |
| $this | assertTo(object|array|string $address, string|null $name = null)
Утверждать, что отправляемое сообщение имеет указанного получателя. | |
| $this | assertHasTo(object|array|string $address, string|null $name = null)
Утверждать, что отправляемое сообщение имеет указанного получателя. | |
| $this | assertHasCc(object|array|string $address, string|null $name = null)
Утверждать, что отправляемое сообщение имеет указанного получателя. | |
| $this | assertHasBcc(object|array|string $address, string|null $name = null)
Утверждать, что отправляемое сообщение имеет указанного получателя. | |
| $this | assertHasReplyTo(object|array|string $address, string|null $name = null)
Утверждать, что отправляемое сообщение имеет указанный адрес ответа. | |
| $this | assertHasSubject(string $subject)
Утверждать, что отправляемое сообщение имеет указанную тему. | |
| $this | assertSeeInHtml(string $string, bool $escape = true)
Утверждать, что данный текст присутствует в теле HTML-письма. | |
| $this | assertDontSeeInHtml(string $string, bool $escape = true)
Утверждать, что данный текст отсутствует в теле HTML-письма. | |
| $this | assertSeeInOrderInHtml(array $strings, bool $escape = true)
Утверждать, что данные текстовые строки присутствуют в указанном порядке в теле HTML-письма. | |
| $this | assertSeeInText(string $string)
Утверждать, что данный текст присутствует в теле простого текстового письма. | |
| $this | assertDontSeeInText(string $string)
Утверждать, что данный текст отсутствует в теле простого текстового письма. | |
| $this | assertSeeInOrderInText(array $strings)
Утверждать, что данные текстовые строки присутствуют в указанном порядке в теле простого текстового письма. |
| $this | assertHasAttachment(string|Прикрепляемый|Вложение $file, array $options = [])
Утверждение, что отправляемое письмо имеет указанное вложение. | |
| $this | assertHasAttachedData(string $data, string $name, array $options = [])
Утверждение, что отправляемое письмо содержит указанные данные как вложение. | |
| $this | assertHasAttachmentFromStorage(string $path, string|null $name = null, array $options = [])
Утверждение, что отправляемое письмо содержит указанное вложение из хранилища. | |
| $this | assertHasAttachmentFromStorageDisk(string $disk, string $path, string|null $name = null, array $options = [])
Утверждение, что отправляемое письмо содержит указанное вложение из определённого диска хранилища. | |
| $this | assertHasTag(string $tag)
Утверждение, что отправляемое письмо имеет указанный тег. | |
| $this | assertHasMetadata(string $key, string $value)
Утверждение, что отправляемое письмо содержит указанные метаданные. | |
| array | renderForAssertions()
Выводит HTML и текстовый вариант отправляемого письма в представления для утверждений. | |
| void | prepareMailableForDelivery()
Подготовка экземпляра отправляемого письма к доставке. | |
| $this | mailer(string $mailer)
Устанавливает имя почтового сервиса, который должен отправить сообщение. | |
| $this | withSymfonyMessage(callable $callback)
Регистрация обратного вызова, который будет вызван с экземпляром сообщения Symfony. | |
| static void | buildViewDataUsing(callable $callback)
Регистрация обратного вызова, который будет вызван во время построения данных представления. |
Подробности
$this|TWhenReturnType when($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное «значение» истинно (или разрешается до истинного).
$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное «значение» ложно (или разрешается до ложного).
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода к заданному объекту.
protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода к заданному объекту, возвращая $this, если перенаправленный вызов вернул себя.
static protected void throwBadMethodCallException(string $method)
Выбросить исключение для вызова несуществующего метода для заданного метода.
mixed withLocale(string $locale, Closure $callback)
Выполнить обратный вызов с заданным языковым стандартом.
static void macro(string $name, object|callable $macro)
Регистрирует пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Смешивает другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static void flushMacros()
Очищает существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
$this __call(string $method, array $parameters)
Динамически привязывает параметры к сообщению.
Отправленное сообщение|null send(Фабрика|Почтовый сервер $mailer)
Отправить сообщение с помощью указанного почтового сервера.
mixed queue(Фабрика $queue)
Поместить сообщение в очередь на отправку.
mixed later(DateTimeInterface|DateInterval|int $delay, Фабрика $queue)
Доставить сообщение в очереди после (n) секунд.
protected mixed newQueuedJob()
Создать экземпляр задания mailable для очереди.
string render()
Отобразить mailable в виде.
protected array|string buildView()
Создать представление для сообщения.
protected array buildMarkdownView()
Создать представление Markdown для сообщения.
array buildViewData()
Создать данные представления для сообщения.
protected Closure buildMarkdownHtml(array $viewData)
Создать HTML-представление для сообщения в формате Markdown.
protected Closure buildMarkdownText(array $viewData)
Создать текстовое представление для сообщения в формате Markdown.
protected Markdown markdownRenderer()
Возвращает экземпляр Markdown с темой почты.
protected $this buildFrom(Сообщение $message)
Добавить отправителя в сообщение.
protected $this buildRecipients(Сообщение $message)
Добавить всех получателей в сообщение.
protected $this buildSubject(Сообщение $message)
Установить тему сообщения.
protected $this buildAttachments(Сообщение $message)
Добавить все вложения к сообщению.
protected void buildDiskAttachments(Сообщение $message)
Добавить все вложения из хранилища к сообщению.
protected $this buildTags(Сообщение $message)
Добавить все определённые теги к сообщению.
protected $this buildMetadata(Сообщение $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)
Определить, задан ли данный получатель в отправляемом письме.
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 в отправляемом письме.
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)
Установить тему сообщения.
bool hasSubject(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|Attachable|Attachment $file, array $options = [])
Прикрепить файл к сообщению.
$this attachMany(array $files)
Прикрепить несколько файлов к сообщению.
bool hasAttachment(string|Attachable|Attachment $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 = [])
Прикрепить файл из хранилища к сообщению.
bool hasAttachmentFromStorage(string $path, string|null $name = null, array $options = [])
Определить, содержит ли сообщение данное вложение из хранилища.
bool hasAttachmentFromStorageDisk(string $disk, string $path, string|null $name = null, array $options = [])
Определить, содержит ли сообщение данное вложение из определенного хранилища.
$this attachData(string $data, string $name, array $options = [])
Прикрепить данные из памяти как вложение.
bool hasAttachedData(string $data, string $name, array $options = [])
Определить, содержит ли сообщение данные в виде вложения.
$this tag(string $value)
Добавить тег в заголовок сообщения, если это поддерживается базовым транспортом.
bool hasTag(string $value)
Определить, содержит ли сообщение данный тег.
$this metadata(string $key, string $value)
Добавить метаданные в заголовок сообщения, если это поддерживается базовым транспортом.
bool hasMetadata(string $key, string $value)
Определить, содержит ли сообщение заданные метаданные.
$this assertFrom(object|array|string $address, string|null $name = null)
Утверждение, что письмо отправлено с указанного адреса.
$this assertTo(object|array|string $address, string|null $name = null)
Утверждение, что письмо адресовано указанному получателю.
$this assertHasTo(object|array|string $address, string|null $name = null)
Утверждение, что письмо адресовано указанному получателю.
$this assertHasCc(object|array|string $address, string|null $name = null)
Утверждение, что письмо содержит указанного получателя в копии.
$this assertHasBcc(object|array|string $address, string|null $name = null)
Утверждение, что письмо содержит указанного получателя в скрытой копии.
$this assertHasReplyTo(object|array|string $address, string|null $name = null)
Утверждение, что письмо содержит указанный адрес для ответа.
$this assertHasSubject(string $subject)
Утверждение, что письмо содержит указанный предмет.
$this assertSeeInHtml(string $string, bool $escape = true)
Утверждение, что указанный текст присутствует в HTML теле письма.
$this assertDontSeeInHtml(string $string, bool $escape = true)
Утверждение, что указанный текст отсутствует в HTML теле письма.
$this assertSeeInOrderInHtml(array $strings, bool $escape = true)
Утверждение, что указанные тексты присутствуют в порядке следования в HTML теле письма.
$this assertSeeInText(string $string)
Утверждение, что указанный текст присутствует в текстовом теле письма.
$this assertDontSeeInText(string $string)
Утверждение, что указанный текст отсутствует в текстовом теле письма.
$this assertSeeInOrderInText(array $strings)
Утверждение, что указанные тексты присутствуют в порядке следования в текстовом теле письма.
$this assertHasAttachment(string|Attachable|Attachment $file, array $options = [])
Утверждение, что письмо содержит указанный вложение.
$this assertHasAttachedData(string $data, string $name, array $options = [])
Утверждение, что письмо содержит указанные данные как вложение.
$this assertHasAttachmentFromStorage(string $path, string|null $name = null, array $options = [])
Утверждение, что письмо содержит указанное вложение из хранилища.
$this assertHasAttachmentFromStorageDisk(string $disk, string $path, string|null $name = null, array $options = [])
Утверждение, что письмо содержит указанное вложение из определенного хранилища.
$this assertHasTag(string $tag)
Утверждение, что письмо содержит указанный тег.
$this assertHasMetadata(string $key, string $value)
Утверждает, что отправляемое письмо имеет указанные метаданные.
protected array renderForAssertions()
Отображает HTML и текстовую версии отправляемого письма в представления для проверки.
protected void prepareMailableForDelivery()
Подготавливает экземпляр отправляемого письма для отправки.
$this mailer(string $mailer)
Устанавливает имя почтового сервера, который должен отправить сообщение.
$this withSymfonyMessage(callable $callback)
Регистрирует обратный вызов, который будет вызван с экземпляром сообщения Symfony.
static void buildViewDataUsing(callable $callback)
Регистрирует обратный вызов, который будет вызван во время построения данных представления.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Mail/Mailable.html
