Mailable

class Mailable implements Mailable (View source)

Свойства

array	$from	Отправитель сообщения.
array	$to	Получатели сообщения.
array	$cc	Получатели сообщения (копия).
array	$bcc	Получатели сообщения (скрытая копия).
array	$replyTo	Адрес для ответа на сообщение.
string	$subject	Тема сообщения.
protected string	$markdown	Шаблон Markdown для сообщения (применимо).
string	$view	Шаблон для сообщения.
string	$textView	Шаблон простого текста для сообщения.
array	$viewData	Данные для представления сообщения.
array	$attachments	Вложения для сообщения.
array	$rawAttachments	Необработанные вложения для сообщения.
array	$callbacks	Обработчики событий для сообщения.

Методы

void

send(Mailer $mailer)

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

mixed

queue(Factory $queue)

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

mixed

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

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

array|string

buildView()

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

array

buildMarkdownView()

Сформировать представление Markdown для сообщения.

array

buildViewData()

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

string

buildMarkdownText(Markdown $markdown, array $data)

Сформировать представление простого текста для сообщения Markdown.

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

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

bool

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

Определить, установлен ли данный получатель в сообщении.

$this

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

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

bool

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

Определить, установлен ли данный получатель в сообщении.

$this

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

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

bool

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

Определить, установлен ли данный получатель в сообщении.

$this

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

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

bool

hasBcc(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')

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

array

addressesToArray(object|array|string $address, string|null $name)

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

object

normalizeRecipient(mixed $recipient)

Преобразовать получателя в объект.

bool

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

Определить, установлен ли данный получатель в сообщении.

$this

subject(string $subject)

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

$this

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

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

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

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

Параметры

Mailer

$mailer

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

void

mixed queue(Factory $queue)

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

Параметры

Factory

$queue

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

mixed

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

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

Параметры

DateTime\|int	$delay
Factory	$queue

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

mixed

protected array|string buildView()

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

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

array|string

protected array buildMarkdownView()

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

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

array

array buildViewData()

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

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

array

protected string buildMarkdownText(Markdown $markdown, array $data)

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

Параметры

Markdown	$markdown
array	$data

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

string

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

bool hasFrom(object|array|string $address, string|null $name = null)

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

Параметры

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

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

bool

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

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

Параметры

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

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

$this

bool hasTo(object|array|string $address, string|null $name = null)

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

Параметры

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

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

bool

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

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

Параметры

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

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

$this

bool hasCc(object|array|string $address, string|null $name = null)

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

Параметры

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

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

bool

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

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

Параметры

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

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

$this

bool hasBcc(object|array|string $address, string|null $name = null)

Определить, задан ли данный получатель в сообщении.

Параметры

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

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

bool

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

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

Все получатели хранятся внутри как [['name' => ?, 'address' => ?]]

Параметры

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

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

$this

protected array addressesToArray(object|array|string $address, string|null $name)

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

Параметры

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

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

array

protected object normalizeRecipient(mixed $recipient)

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

Параметры

mixed

$recipient

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

object

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

Определить, задан ли данный получатель в сообщении.

Параметры

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

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

bool

$this subject(string $subject)

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

Параметры

string

$subject

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

$this

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

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

Параметры

string	$view
array	$data

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

$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.4/Illuminate/Mail/Mailable.html