MailMessage

class MailMessage extends SimpleMessage implements Renderable (View source)

Свойства

string	$level	Уровень уведомления (info, success, error).	из SimpleMessage
string	$subject	Тема уведомления.	из SimpleMessage
string	$greeting	Приветствие уведомления.	из SimpleMessage
string	$salutation	Обращение уведомления.	из SimpleMessage
array	$introLines	Строки введения уведомления.	из SimpleMessage
array	$outroLines	Строки заключения уведомления.	из SimpleMessage
string	$actionText	Текст/метка для действия.	из SimpleMessage
string	$actionUrl	URL действия.	из 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

with(mixed $line)

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

from SimpleMessage

Htmlable|string

formatLine(Htmlable|string|array $line)

Форматирует заданную строку текста.

from SimpleMessage

$this

action(string $text, string $url)

Настройка кнопки "действие".

from SimpleMessage

array

toArray()

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

from SimpleMessage

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

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

array

parseAddresses(array $value)

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

bool

arrayOfAddresses(mixed $address)

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

string

render()

Вывод сообщения уведомления по электронной почте в строку HTML.

$this

withSwiftMessage(callable $callback)

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

Details

$this success()

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

Return Value

$this

$this error()

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

Return Value

$this

$this level(string $level)

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

Parameters

string

$level

Return Value

$this

$this subject(string $subject)

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

Parameters

string

$subject

Return Value

$this

$this greeting(string $greeting)

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

Parameters

string

$greeting

Return Value

$this

$this salutation(string $salutation)

Устанавливает обращение в уведомлении.

Parameters

string

$salutation

Return Value

$this

$this line(mixed $line)

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

Parameters

mixed

$line

Return Value

$this

$this with(mixed $line)

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

Parameters

mixed

$line

Return Value

$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

array toArray()

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

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

array

$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.

Параметры

string

$theme

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

$this

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

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

Параметры

string	$address
string\|null	$name

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

$this

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

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

Параметры

array\|string	$address
string\|null	$name

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

$this

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

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

Параметры

array\|string	$address
string\|null	$name

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

$this

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

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

Параметры

array\|string	$address
string\|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 message.

Параметры

callable

$callback

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

$this

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