Mailable

class Mailable implements Mailable, Renderable (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)

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

string

render()

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

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)

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

bool

hasReplyTo(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

string render()

Рендерить рассылку в представление.

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

string

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

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

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

Параметры

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

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

bool

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