Spec-Zone.ru › Laravel 5.6

MailMessage

class MailMessage extends SimpleMessage (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 для отображения (при необходимости).
array $from Информация "от" для сообщения.
array $replyTo Информация "ответ на" для сообщения.
array $cc Информация "копия" для сообщения.
array $bcc Информация "скрытая копия" для сообщения.
array $attachments Вложения для сообщения.
array $rawAttachments Исходные вложения для сообщения.
int $priority Уровень приоритета сообщения.

Методы

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

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

Подробности

$this success()

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

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

$this

$this error()

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

Значение возвращаемого значения

$this

$this level(string $level)

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

Параметры

string $level

Значение возвращаемого значения

$this

$this subject(string $subject)

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

Параметры

string $subject

Значение возвращаемого значения

$this

$this greeting(string $greeting)

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

Параметры

string $greeting

Значение возвращаемого значения

$this

$this salutation(string $salutation)

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

Параметры

string $salutation

Значение возвращаемого значения

$this

$this line(mixed $line)

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

Параметры

mixed $line

Значение возвращаемого значения

$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

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 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
END_OF_DOCUMENT_MARKER

protected bool arrayOfAddresses(mixed $address)

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

Параметры

mixed $address

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

bool

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API