Spec-Zone.ru › Laravel 5.5

Почтовый клиент

класс Mailer реализует Mailer, MailQueue (Просмотреть исходный код)

Трейты

Macroable

Свойства

статический защищенный массив $macros Зарегистрированные строковые макросы. из Macroable
защищенный Factory $views Экземпляр фабрики представлений.
защищенный Swift_Mailer $swift Экземпляр Swift Mailer.
защищенный Dispatcher|null $events Экземпляр диспетчера событий.
защищенный массив $from Глобальный адрес и имя отправителя.
защищенный массив $replyTo Глобальный адрес и имя для ответа.
защищенный массив $to Глобальный адрес и имя получателя.
защищенный Queue $queue Реализация очереди.
защищенный массив $failedRecipients Массив неудачных получателей.

Методы

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

from Macroable
static void mixin(object $mixin)

Добавить другой объект в класс.

from Macroable
static bool hasMacro(string $name)

Проверить, зарегистрировано ли макро.

from Macroable
static mixed __callStatic(string $method, array $parameters)

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

from Macroable
mixed __call(string $method, array $parameters)

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

from Macroable
void __construct(Factory $views, Swift_Mailer $swift, Dispatcher $events = null)

Создать новый экземпляр Mailer.

void alwaysFrom(string $address, string|null $name = null)

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

void alwaysReplyTo(string $address, string|null $name = null)

Установить глобальный адрес и имя для ответа.

void alwaysTo(string $address, string|null $name = null)

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

PendingMail to(mixed $users)

Начать процесс отправки экземпляра класса mailable.

PendingMail bcc(mixed $users)

Начать процесс отправки экземпляра класса mailable.

void raw(string $text, mixed $callback)

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

void plain(string $view, array $data, mixed $callback)

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

View render(string|array $view, array $data = [])

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

void send(string|array|MailableContract $view, array $data = [], Closure|string $callback = null)

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

mixed sendMailable(Mailable $mailable)

Отправить заданный mailable.

array parseView(string|array $view)

Разбор заданного имени представления или массива.

void addContent(Message $message, string $view, string $plain, string $raw, array $data)

Добавить содержимое в заданное сообщение.

string renderView(string $view, array $data)

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

void setGlobalTo(Message $message)

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

mixed queue(string|array|MailableContract $view, string $queue = null)

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

mixed onQueue(string $queue, string|array $view)

Поместить новое электронное письмо в очередь для отправки в заданную очередь.

mixed queueOn(string $queue, string|array $view)

Поместить новое электронное письмо в очередь для отправки в заданную очередь.

mixed later(DateTimeInterface|DateInterval|int $delay, string|array|MailableContract $view, string $queue = null)

Поместить новое электронное письмо в очередь для отправки через (n) секунд.

mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string|array $view)

Поместить новое электронное письмо в очередь для отправки через (n) секунд в заданную очередь.

Message createMessage()

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

void sendSwiftMessage(Swift_Message $message)

Отправить экземпляр Swift Message.

bool shouldSendMessage(Swift_Message $message)

Определяет, может ли быть отправлено сообщение.

void dispatchSentEvent(Message $message)

Отправить событие отправки сообщения.

void forceReconnection()

Принудительно переподключиться к транспорту.

Factory getViewFactory()

Получить экземпляр фабрики представлений.

Swift_Mailer getSwiftMailer()

Получить экземпляр Swift Mailer.

array failures()

Получить массив неудачных получателей.

void setSwiftMailer(Swift_Mailer $swift)

Установить экземпляр Swift Mailer.

$this setQueue(Factory $queue)

Установить экземпляр менеджера очереди.

Details

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

Добавить другой объект в класс.

Parameters

object $mixin

Return Value

void

static bool hasMacro(string $name)

Проверить, зарегистрировано ли макро.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct(Factory $views, Swift_Mailer $swift, Dispatcher $events = null)

Создать новый экземпляр Mailer.

Параметры

Factory $views
Swift_Mailer $swift
Dispatcher $events

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

void

void alwaysFrom(string $address, string|null $name = null)

Установить глобальный адрес и имя от.

Параметры

string $address
string|null $name

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

void

void alwaysReplyTo(string $address, string|null $name = null)

Установить глобальный адрес и имя ответа.

Параметры

string $address
string|null $name

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

void

void alwaysTo(string $address, string|null $name = null)

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

Параметры

string $address
string|null $name

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

void

PendingMail to(mixed $users)

Начать процесс отправки экземпляра класса mailable.

Параметры

mixed $users

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

PendingMail

PendingMail bcc(mixed $users)

Начать процесс отправки экземпляра класса mailable.

Параметры

mixed $users

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

PendingMail

void raw(string $text, mixed $callback)

Отправить новое сообщение, когда есть только часть raw текста.

Параметры

string $text
mixed $callback

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

void

void plain(string $view, array $data, mixed $callback)

Отправить новое сообщение, когда есть только часть plain.

Параметры

string $view
array $data
mixed $callback

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

void

View render(string|array $view, array $data = [])

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

Параметры

string|array $view
array $data

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

View

void send(string|array|MailableContract $view, array $data = [], Closure|string $callback = null)

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

Параметры

string|array|MailableContract $view
array $data
Closure|string $callback

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

void

protected mixed sendMailable(Mailable $mailable)

Отправить переданный mailable.

Параметры

Mailable $mailable

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

mixed

protected array parseView(string|array $view)

Проанализировать заданное имя представления или массив.

Параметры

string|array $view

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

array

Исключения

InvalidArgumentException

protected void addContent(Message $message, string $view, string $plain, string $raw, array $data)

Добавить содержимое в заданное сообщение.

Параметры

Message $message
string $view
string $plain
string $raw
array $data

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

void

protected string renderView(string $view, array $data)

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

Параметры

string $view
array $data

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

string

protected void setGlobalTo(Message $message)

Установить глобальный адрес "to" в данном сообщении.

Параметры

Message $message

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

void

смешанный тип queue(string|array|MailableContract $view, string $queue = null)

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

Параметры

string|array|MailableContract $view
string $queue

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

смешанный тип

смешанный тип onQueue(string $queue, string|array $view)

Поместить новое электронное письмо в очередь для отправки в заданной очереди.

Параметры

string $queue
string|array $view

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

смешанный тип

смешанный тип queueOn(string $queue, string|array $view)

Поместить новое электронное письмо в очередь для отправки в заданной очереди.

Этот метод не соответствовал фразе "onQueue" остальной части фреймворка. Добавлено "onQueue".

Параметры

string $queue
string|array $view

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

смешанный тип

смешанный тип later(DateTimeInterface|DateInterval|int $delay, string|array|MailableContract $view, string $queue = null)

Поместить новое электронное письмо в очередь для отправки через (n) секунд.

Параметры

DateTimeInterface|DateInterval|int $delay
string|array|MailableContract $view
string $queue

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

смешанный тип

смешанный тип laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string|array $view)

Поместить новое электронное письмо в очередь для отправки через (n) секунд в заданной очереди.

Параметры

string $queue
DateTimeInterface|DateInterval|int $delay
string|array $view

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

смешанный тип

защищенный Message createMessage()

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

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

Message

защищенный void sendSwiftMessage(Swift_Message $message)

Отправить экземпляр Swift Message.

Параметры

Swift_Message $message

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

void

защищенный bool shouldSendMessage(Swift_Message $message)

Определяет, может ли быть отправлено сообщение.

Параметры

Swift_Message $message

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

bool

защищенный void dispatchSentEvent(Message $message)

Отправить событие отправки сообщения.

Параметры

Message $message

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

void

защищенный void forceReconnection()

Принудительно переподключиться к транспорту.

Это предотвратит ошибки в ситуациях очереди демон-сервера.

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

void

Factory getViewFactory()

Получить экземпляр фабрики представлений.

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

Factory

Swift_Mailer getSwiftMailer()

Получить экземпляр Swift Mailer.

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

Swift_Mailer

массив failures()

Получить массив несостоявшихся получателей.

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

массив

void setSwiftMailer(Swift_Mailer $swift)

Установить экземпляр Swift Mailer.

Параметры

Swift_Mailer $swift

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

void

$this setQueue(Factory $queue)

Установить экземпляр менеджера очереди.

Параметры

Factory $queue

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

$this

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

Spec-Zone.ru

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