Mailable
class Mailable implements Mailable, Renderable (View source)
Свойства
| Conditionable | |
| ForwardsCalls | |
| Localizable | |
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | from Macroable |
| 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 | Вложения из хранилища. | |
| protected array | $tags | Теги сообщения. | |
| protected array | $metadata | Метаданные сообщения. | |
| array | $callbacks | Обратные вызовы для сообщения. | |
| string|null | $theme | Название темы, которая должна использоваться при форматировании сообщения. | |
| string | $mailer | Имя почтового отправителя, который должен отправить сообщение. | |
| protected array | $assertionableRenderStrings | Рендеренные представления почтового сообщения для тестирования/утверждений. | |
| static callable | $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()
Создать данные представления для сообщения. | |
| 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 | 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)
Определить, установлен ли данный адрес "ответить отправителю" в почтовом сообщении. | |
| $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)
Утвердить, что указанный текст присутствует в HTML-теле сообщения. | |
| $this | assertDontSeeInHtml(string $string)
Утвердить, что указанный текст отсутствует в HTML-теле сообщения. | |
| $this | assertSeeInOrderInHtml(array $strings)
Утвердить, что заданные текстовые строки присутствуют в порядке в 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)
Утверждение, что отправляемое письмо имеет заданные метаданные. | |
| array | renderForAssertions()
Отображение HTML и версии с простым текстом отправляемого письма в представления для проверок. | |
| $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)
Динамически привязать параметры к сообщению.
SentMessage|null send(Factory|Mailer $mailer)
Отправить сообщение с помощью указанного почтового сервера.
mixed queue(Factory $queue)
Поместить сообщение в очередь для отправки.
mixed later(DateTimeInterface|DateInterval|int $delay, Factory $queue)
Доставить сообщение в очереди через (n) секунд.
protected mixed newQueuedJob()
Создать экземпляр задачи отправки по очереди.
string render()
Отобразить отправляемое письмо в представлении.
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 void buildDiskAttachments(Message $message)
Добавить все вложения из диска к сообщению.
protected $this buildTags(Message $message)
Добавить все определенные теги в сообщение.
protected $this buildMetadata(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)
Определите, установлен ли указанный получатель в почтовом сообщении.
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|Присоединяемый|Прикрепление $file, array $options = [])
Прикрепить файл к сообщению.
$this attachMany(array $files)
Прикрепить несколько файлов к сообщению.
bool hasAttachment(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 = [])
Прикрепить файл из хранилища к сообщению.
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)
Утверждать, что указанный текст присутствует в HTML теле электронного письма.
$this assertDontSeeInHtml(string $string)
Утверждать, что указанный текст не присутствует в HTML теле электронного письма.
$this assertSeeInOrderInHtml(array $strings)
Утверждать, что указанные текстовые строки присутствуют в 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 и текстовую версии посылаемого сообщения в представления для утверждений.
$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/9.x/Illuminate/Mail/Mailable.html
