Сообщение электронной почты
класс Сообщение электронной почты расширяет Простое сообщение и реализует Представление (Просмотреть исходный код)
Трейты
| Условный |
Свойства
| string | $level | Уровень уведомления (info, success, error). | from SimpleMessage |
| string | $subject | Тема уведомления. | from SimpleMessage |
| string | $greeting | Приветствие в уведомлении. | from SimpleMessage |
| string | $salutation | Заключительное обращение в уведомлении. | from SimpleMessage |
| array | $introLines | Строки «вступления» в уведомлении. | from SimpleMessage |
| array | $outroLines | Строки «заключения» в уведомлении. | from SimpleMessage |
| string | $actionText | Текст/метка для действия. | from SimpleMessage |
| string | $actionUrl | URL действия. | from SimpleMessage |
| string | $mailer | Имя почтового сервиса для отправки уведомления. | from SimpleMessage |
| array|string | $view | Представление для отрисовки. |
| array | $viewData | Данные представления для сообщения. | |
| string|null | $markdown | Шаблон Markdown для рендеринга (применимо). | |
| string|null | $theme | Текущая тема, используемая при создании электронных писем. | |
| array | $from | Информация "от" для сообщения. | |
| array | $replyTo | Информация "ответ на" для сообщения. | |
| array | $cc | Информация "копия" для сообщения. | |
| array | $bcc | Информация "скрытая копия" для сообщения. | |
| array | $attachments | Вложения для сообщения. | |
| array | $rawAttachments | Необработанные вложения для сообщения. | |
| array | $tags | Теги для сообщения. | |
| array | $metadata | Метаданные для сообщения. | |
| int | $priority | Уровень приоритета сообщения. | |
| array | $callbacks | Обратные вызовы для сообщения. |
Методы
| $this | success()
Укажите, что уведомление содержит информацию об успешном выполнении операции. | from SimpleMessage |
| $this | error()
Укажите, что уведомление содержит информацию об ошибке. | from SimpleMessage |
| $this | level(string $level)
Установите "уровень" уведомления (успех, ошибка и т. д.). | from SimpleMessage |
| $this | subject(string $subject)
Установите тему уведомления. | from SimpleMessage |
| $this | greeting(string $greeting)
Установите приветствие в уведомлении. | from SimpleMessage |
| $this | salutation(string $salutation)
Установите заключение уведомления. | from SimpleMessage |
| $this | line(mixed $line)
Добавить строку текста в уведомление. | from SimpleMessage |
| $this | lineIf(bool $boolean, mixed $line)
Добавить строку текста в уведомление, если заданное условие истинно. | from SimpleMessage |
| $this | lines(iterable $lines)
Добавить строки текста в уведомление. | from SimpleMessage |
| $this | linesIf(bool $boolean, iterable $lines)
Добавить строки текста в уведомление, если заданное условие истинно. | from SimpleMessage |
| $this | with(mixed $line)
Добавить строку текста в уведомление. | from SimpleMessage |
| Htmlable|string | formatLine(Htmlable|string|array $line)
Отформатировать заданную строку текста. | from SimpleMessage |
| $this | action(string $text, string $url)
Настроить кнопку "вызова к действию". | from SimpleMessage |
| $this | mailer(string $mailer)
Установить имя почтового сервера, который должен отправить уведомление. | from SimpleMessage |
| array | toArray()
Получить массивное представление сообщения. | from SimpleMessage |
| $this|TWhenReturnType | when($value = null, callable $callback = null, callable $default = null)
Примените обратный вызов, если заданное «значение» истинно (или разрешается до истинного). | из Conditionable |
| $this|TUnlessReturnType | unless($value = null, callable $callback = null, callable $default = null)
Примените обратный вызов, если заданное «значение» ложно (или разрешается до ложного). | из Conditionable |
| $this | view(array|string $view, array $data = [])
Установите представление для сообщения электронной почты. | |
| $this | markdown(string $view, array $data = [])
Установите шаблон Markdown для уведомления. | |
| $this | template(string $template)
Установите шаблон по умолчанию для Markdown. | |
| $this | theme(string $theme)
Установите тему для использования с шаблоном Markdown. | |
| $this | from(string $address, string|null $name = null)
Установите адрес отправителя для сообщения электронной почты. | |
| $this | replyTo(array|string $address, string|null $name = null)
Установите адрес «ответить отправителю» сообщения. | |
| $this | cc(array|string $address, string|null $name = null)
Установите адрес cc для сообщения электронной почты. | |
| $this | bcc(array|string $address, string|null $name = null)
Установите адрес bcc для сообщения электронной почты. |
| $this | attach(string|Attachable|Attachment $file, array $options = [])
Прикрепить файл к сообщению. | |
| $this | attachData(string $data, string $name, array $options = [])
Прикрепить данные из памяти в качестве вложения. | |
| $this | tag(string $value)
Добавить заголовок тега в сообщение, если это поддерживается базовым транспортом. | |
| $this | metadata(string $key, string $value)
Добавить заголовок метаданных в сообщение, если это поддерживается базовым транспортом. | |
| $this | priority(int $level)
Установить приоритет этого сообщения. | |
| array | data()
Получить массив данных для сообщения электронной почты. | |
| array | parseAddresses(array $value)
Разделить массив адресов для необходимой обработки. | |
| bool | arrayOfAddresses(mixed $address)
Определить, является ли указанный "адрес" массивом адресов. | |
| string | render()
Отобразить сообщение уведомления электронной почты в виде HTML-строки. | |
| $this | withSymfonyMessage(callable $callback)
Зарегистрировать обратный вызов, который будет вызван с экземпляром сообщения Symfony. |
Подробности
$this success()
Укажите, что уведомление содержит информацию об успешной операции.
$this error()
Укажите, что уведомление содержит информацию об ошибке.
$this level(string $level)
Установите "уровень" уведомления (успех, ошибка и т. д.).
$this subject(string $subject)
Установите тему уведомления.
$this greeting(string $greeting)
Установите приветствие в уведомлении.
$this salutation(string $salutation)
Установите обращение в уведомлении.
$this line(mixed $line)
Добавить строку текста в уведомление.
$this lineIf(bool $boolean, mixed $line)
Добавить строку текста в уведомление, если заданное условие истинно.
$this lines(iterable $lines)
Добавить строки текста в уведомление.
$this linesIf(bool $boolean, iterable $lines)
Добавить строки текста в уведомление, если заданное условие истинно.
$this with(mixed $line)
Добавить строку текста в уведомление.
protected Htmlable|string formatLine(Htmlable|string|array $line)
Отформатировать заданную строку текста.
$this action(string $text, string $url)
Настроить кнопку «вызова к действию».
$this mailer(string $mailer)
Установить имя почтового сервера, который должен отправить уведомление.
array toArray()
Получить массивное представление сообщения.
$this|TWhenReturnType when($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное «значение» истинно.
$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное «значение» ложно.
$this view(array|string $view, array $data = [])
Установить представление для сообщения по электронной почте.
$this markdown(string $view, array $data = [])
Установить шаблон Markdown для уведомления.
$this template(string $template)
Установите шаблон по умолчанию для разметки Markdown.
$this theme(string $theme)
Установите тему для использования с шаблоном Markdown.
$this from(string $address, string|null $name = null)
Установите адрес отправителя для сообщения электронной почты.
$this replyTo(array|string $address, string|null $name = null)
Установите адрес "ответ на" для сообщения.
$this cc(array|string $address, string|null $name = null)
Установите адрес cc для сообщения электронной почты.
$this bcc(array|string $address, string|null $name = null)
Установите адрес bcc для сообщения электронной почты.
$this attach(string|Присоединяемый|Вложение $file, array $options = [])
Прикрепить файл к сообщению.
$this attachData(string $data, string $name, array $options = [])
Прикрепить данные из памяти в качестве вложения.
$this tag(string $value)
Добавить заголовок тега в сообщение, если это поддерживается базовым транспортом.
$this metadata(string $key, string $value)
Добавить заголовок метаданных к сообщению, если это поддерживается основным транспортом.
$this priority(int $level)
Установить приоритет этого сообщения.
Значение — целое число, где 1 — самый высокий приоритет, а 5 — самый низкий.
array data()
Получить массив данных для электронного сообщения.
protected array parseAddresses(array $value)
Обработать массив адресов в нужный формат.
protected bool arrayOfAddresses(mixed $address)
Определить, является ли заданный «адрес» на самом деле массивом адресов.
string render()
Отобразить сообщение электронной уведомления в строку HTML.
$this withSymfonyMessage(callable $callback)
Зарегистрировать обратный вызов, который будет вызван с экземпляром сообщения Symfony.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Notifications/Messages/MailMessage.html
