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

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

Свойства

protected Factory	$views	Экземпляр фабрики представления.
protected Swift_Mailer	$swift	Экземпляр Swift Mailer.
protected Dispatcher\|null	$events	Экземпляр диспетчера событий.
protected array	$from	Глобальный адрес и имя отправителя.
protected LoggerInterface	$logger	Экземпляр записывателя логов.
protected Container	$container	Экземпляр контейнера IoC.
protected Queue	$queue	Реализация очереди.
protected bool	$pretending	Указывает, отключено ли фактическое отправление.
protected array	$failedRecipients	Массив неудачных получателей.

Методы

void

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

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

void

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

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

void

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

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

int

raw(string $text, Closure|string $callback)

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

int

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

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

void

send(string|array $view, array $data, Closure|string $callback)

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

mixed

queue(string|array $view, array $data, Closure|string $callback, string $queue = null)

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

mixed

onQueue(string $queue, string|array $view, array $data, Closure|string $callback)

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

mixed

queueOn(string $queue, string|array $view, array $data, Closure|string $callback)

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

mixed

later(int $delay, string|array $view, array $data, Closure|string $callback, string $queue = null)

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

mixed

laterOn(string $queue, int $delay, string|array $view, array $data, Closure|string $callback)

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

mixed

buildQueueCallable(mixed $callback)

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

void

handleQueuedMessage(Job $job, array $data)

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

mixed

getQueuedCallable(array $data)

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

void

forceReconnection()

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

void

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

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

array

parseView(string|array $view)

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

void

sendSwiftMessage(Swift_Message $message)

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

void

logMessage(Swift_Message $message)

Залогировать отправку сообщения.

mixed

callMessageBuilder(Closure|string $callback, Message $message)

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

Message

createMessage()

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

View

getView(string $view, array $data)

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

void

pretend(bool $value = true)

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

bool

isPretending()

Проверить, имитирует ли мейлер отправку сообщений.

Factory

getViewFactory()

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

Swift_Mailer

getSwiftMailer()

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

array

failures()

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

void

setSwiftMailer(Swift_Mailer $swift)

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

$this

setLogger(LoggerInterface $logger)

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

$this

setQueue(Queue $queue)

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

void

setContainer(Container $container)

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

Подробности

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 alwaysTo(string $address, string|null $name = null)

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

Параметры

string	$address
string\|null	$name

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

void

int raw(string $text, Closure|string $callback)

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

Параметры

string	$text
Closure\|string	$callback

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

int

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

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

Параметры

string	$view
array	$data
mixed	$callback

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

int

void send(string|array $view, array $data, Closure|string $callback)

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

Параметры

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

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

void

mixed queue(string|array $view, array $data, Closure|string $callback, string $queue = null)

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

Параметры

string\|array	$view
array	$data
Closure\|string	$callback
string	$queue

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

mixed

mixed onQueue(string $queue, string|array $view, array $data, Closure|string $callback)

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

Параметры

string	$queue
string\|array	$view
array	$data
Closure\|string	$callback

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

mixed

mixed queueOn(string $queue, string|array $view, array $data, Closure|string $callback)

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

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

Параметры

string	$queue
string\|array	$view
array	$data
Closure\|string	$callback

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

mixed

mixed later(int $delay, string|array $view, array $data, Closure|string $callback, string $queue = null)

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

Параметры

int	$delay
string\|array	$view
array	$data
Closure\|string	$callback
string	$queue

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

mixed

mixed laterOn(string $queue, int $delay, string|array $view, array $data, Closure|string $callback)

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

Параметры

string	$queue
int	$delay
string\|array	$view
array	$data
Closure\|string	$callback

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

mixed

protected mixed buildQueueCallable(mixed $callback)

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

Параметры

mixed

$callback

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

mixed

void handleQueuedMessage(Job $job, array $data)

Обработать задачу электронного письма из очереди.

Параметры

Job	$job
array	$data

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

void

protected mixed getQueuedCallable(array $data)

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

Параметры

array

$data

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

mixed

protected void forceReconnection()

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

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

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

void

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 array parseView(string|array $view)

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

Параметры

string|array

$view

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

array

Исключения

InvalidArgumentException

protected void sendSwiftMessage(Swift_Message $message)

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

Параметры

Swift_Message

$message

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

void

protected void logMessage(Swift_Message $message)

Залогировать отправку сообщения.

Параметры

Swift_Message

$message

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

void

protected mixed callMessageBuilder(Closure|string $callback, Message $message)

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

Параметры

Closure\|string	$callback
Message	$message

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

mixed

Исключения

InvalidArgumentException

protected Message createMessage()

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

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

Message

protected View getView(string $view, array $data)

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

Параметры

string	$view
array	$data

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

View

void pretend(bool $value = true)

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

Параметры

bool

$value

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

void

bool isPretending()

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

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

bool

Factory getViewFactory()

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

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

Factory

Swift_Mailer getSwiftMailer()

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

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

Swift_Mailer

array failures()

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

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

array

void setSwiftMailer(Swift_Mailer $swift)

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

Параметры

Swift_Mailer

$swift

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

void

$this setLogger(LoggerInterface $logger)

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

Параметры

LoggerInterface

$logger

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

$this

$this setQueue(Queue $queue)

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

Параметры

Queue

$queue

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

$this

void setContainer(Container $container)

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

Параметры

Container

$container

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

void

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