MailMessage

class MailMessage extends SimpleMessage implements Renderable (View source)

Свойства

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	Необработанные вложения для сообщения.
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	lines(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\|mixed	when(mixed $value, callable $callback, callable\|null $default = null) Применить обратный вызов, если заданное «значение» истинно.	from Conditionable
$this\|mixed	unless(mixed $value, callable $callback, callable\|null $default = null) Применить обратный вызов, если заданное «значение» ложно.	from 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 $file, array $options = []) Прикрепить файл к сообщению.
$this	attachData(string $data, string $name, array $options = []) Прикрепить данные из памяти как вложение.
$this	priority(int $level) Установите приоритет этого сообщения.
array	data() Получить массив данных для сообщения электронной почты.

массив	parseAddresses(массив $value) Разбирает массив многоадресных сообщений в необходимый формат.
логическое значение	arrayOfAddresses(смешанный тип $address) Определяет, является ли заданный «адрес» фактически массивом адресов.
строка	render() Отображает сообщение уведомления по электронной почте в строку HTML.
$this	withSwiftMessage(вызов $callback) Регистрирует обратный вызов, который будет вызван с экземпляром Swift-сообщения.

Подробности

$this success()

Указывает, что уведомление содержит информацию об успешной операции.

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

$this

$this error()

Указывает, что уведомление содержит информацию об ошибке.

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

$this

$this level(строка $level)

Устанавливает «уровень» уведомления (успех, ошибка и т.д.).

Параметры

строка

$level

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

$this

$this subject(строка $subject)

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

Параметры

строка

$subject

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

$this

$this greeting(string $greeting)

Установите приветствие уведомления.

Параметры

string

$greeting

Значение возврата

$this

$this salutation(string $salutation)

Установите приветствие уведомления.

Параметры

string

$salutation

Значение возврата

$this

$this line(mixed $line)

Добавить строку текста в уведомление.

Параметры

mixed

$line

Значение возврата

$this

$this lines(iterable $lines)

Добавить строки текста в уведомление.

Параметры

iterable

$lines

Значение возврата

$this

$this with(mixed $line)

Добавить строку текста в уведомление.

Параметры

mixed

$line

Значение возврата

$this

protected Htmlable|string formatLine(Htmlable|string|array $line)

Отформатировать заданную строку текста.

Параметры

Htmlable|string|array

$line

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

Htmlable|string

$this action(string $text, string $url)

Настроить кнопку «вызова к действию».

Параметры

string	$text
string	$url

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

$this

$this mailer(string $mailer)

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

Параметры

string

$mailer

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

$this

array toArray()

Получить массивное представление сообщения.

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

array

$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

$this view(array|string $view, array $data = [])

Установите представление для сообщения почты.

Параметры

array\|string	$view
array	$data

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

$this

$this markdown(string $view, array $data = [])

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

Параметры

string	$view
array	$data

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

$this

$this template(string $template)

Установите по умолчанию шаблон markdown.

Параметры

string

$template

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

$this

$this theme(string $theme)

Установите тему для использования с шаблоном Markdown.

Параметры

строка

$theme

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

$this

$this from(string $address, string|null $name = null)

Установите адрес от для сообщения электронной почты.

Параметры

строка	$address
строка\|null	$name

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

$this

$this replyTo(array|string $address, string|null $name = null)

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

Параметры

массив\|строка	$address
строка\|null	$name

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

$this

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

Установите адрес cc для сообщения электронной почты.

Параметры

массив\|строка	$address
строка\|null	$name

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

$this

$this bcc(array|string $address, string|null $name = null)

Установите адрес bcc для сообщения электронной почты.

Параметры

массив\|строка	$address
строка\|null	$name

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

$this

$this attach(string $file, array $options = [])

Прикрепить файл к сообщению.

Параметры

string	$file
array	$options

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

$this

$this attachData(string $data, string $name, array $options = [])

Прикрепить данные из памяти как вложение.

Параметры

string	$data
string	$name
array	$options

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

$this

$this priority(int $level)

Установить приоритет этого сообщения.

Значение — целое число, где 1 — наивысший приоритет, а 5 — наименьший.

Параметры

int

$level

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

$this

array data()

Получить массив данных для почтового сообщения.

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

array

protected array parseAddresses(array $value)

Разбор массива многоадресных получателей в необходимый формат.

Параметры

array

$value

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

array

protected bool arrayOfAddresses(mixed $address)

Определить, является ли заданный "адрес" на самом деле массивом адресов.

Параметры

mixed

$address

Значение возврата

bool

string render()

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

Значение возврата

string

$this withSwiftMessage(callable $callback)

Зарегистрировать обратный вызов, который будет вызван с экземпляром сообщения Swift.

Параметры

callable

$callback

Значение возврата

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Notifications/Messages/MailMessage.html