Spec-Zone.ru › Laravel 5.3

Mailable

class Mailable implements Mailable (View source)

Свойства

массив $from Отправитель сообщения.
массив $to Получатели сообщения.
массив $cc Получатели сообщения в копии.
массив $bcc Получатели сообщения в скрытой копии.
массив $replyTo Получатели для ответа на сообщение.
строка $subject Тема сообщения.
строка $view Шаблон для отображения сообщения.
строка $textView Шаблон для отображения сообщения в простом текстовом формате.
массив $viewData Данные для шаблона сообщения.
массив $attachments Вложения к сообщению.
массив $rawAttachments Необработанные вложения к сообщению.
массив $callbacks Обработчики событий сообщения.

Методы

void send(Mailer $mailer)

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

mixed queue(Factory $queue)

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

mixed later(DateTime|int $delay, Factory $queue)

Отправка сообщения в очереди после заданной задержки.

массив|строка buildView()

Создание представления для сообщения.

массив buildViewData()

Создание данных представления для сообщения.

$this buildFrom(Message $message)

Добавление отправителя к сообщению.

$this buildRecipients(Message $message)

Добавление всех получателей к сообщению.

$this buildSubject(Message $message)

Установление темы сообщения.

$this buildAttachments(Message $message)

Добавление всех вложений к сообщению.

$this runCallbacks(Message $message)

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

$this priority(int $level = 3)

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

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

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

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

Установка получателей сообщения.

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

Установка получателей сообщения в копии.

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

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

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

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

$this setAddress(object|array|string $address, string|null $name = null, string $property = 'to')

Установка получателей сообщения.

object parseUser(mixed $user)

Разбор заданного пользователя в объект.

$this subject(string $subject)

Установление темы сообщения.

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

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

$this text(string $textView, array $data = [])

Установка представления сообщения в простом текстовом формате.

$this with(string|array $key, mixed $value = null)

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

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

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

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

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

$this withSwiftMessage(callable $callback)

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

$this __call(string $method, array $parameters)

Динамическое привязывание параметров к сообщению.

Подробности

void send(Mailer $mailer)

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

Parameters

Mailer $mailer

Return Value

void

mixed queue(Factory $queue)

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

Parameters

Factory $queue

Return Value

mixed

mixed later(DateTime|int $delay, Factory $queue)

Отправка сообщения в очереди после заданной задержки.

Parameters

DateTime|int $delay
Factory $queue

Return Value

mixed

protected array|string buildView()

Создание представления для сообщения.

Return Value

array|string

array buildViewData()

Создание данных представления для сообщения.

Return Value

array

protected $this buildFrom(Message $message)

Добавить отправителя в сообщение.

Параметры

Message $message

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

$this

protected $this buildRecipients(Message $message)

Добавить всех получателей в сообщение.

Параметры

Message $message

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

$this

protected $this buildSubject(Message $message)

Установить тему сообщения.

Параметры

Message $message

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

$this

protected $this buildAttachments(Message $message)

Добавить все вложения к сообщению.

Параметры

Message $message

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

$this

protected $this runCallbacks(Message $message)

Выполнить обратные вызовы для сообщения.

Параметры

Message $message

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

$this

$this priority(int $level = 3)

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

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

Параметры

int $level

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

$this

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

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

Параметры

object|array|string $address
string|null $name

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

$this

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

Установить получателей сообщения.

Параметры

object|array|string $address
string|null $name

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

$this

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

Установить получателей сообщения.

Параметры

object|array|string $address
string|null $name

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

$this

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

Установить получателей сообщения.

Параметры

object|array|string $address
string|null $name

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

$this

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

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

Параметры

object|array|string $address
string|null $name

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

$this

protected $this setAddress(object|array|string $address, string|null $name = null, string $property = 'to')

Установить получателей сообщения.

Параметры

object|array|string $address
string|null $name
string $property

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

$this

protected object parseUser(mixed $user)

Обработать заданного пользователя в объект.

Параметры

mixed $user

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

object

$this subject(string $subject)

Установить тему сообщения.

Параметры

string $subject

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

$this

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

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

Параметры

string $view
array $data

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

$this

$this text(string $textView, array $data = [])

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

Параметры

string $textView
array $data

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

$this

$this with(string|array $key, mixed $value = null)

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

Параметры

string|array $key
mixed $value

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

$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 withSwiftMessage(callable $callback)

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

Параметры

callable $callback

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

$this

$this __call(string $method, array $parameters)

Динамично привязывает параметры к сообщению.

Параметры

string $method
array $parameters

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

$this

Исключения

BadMethodCallException

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Mail/Mailable.html

Spec-Zone.ru

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