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

класс Почтовый клиент (Просмотреть исходный код)

Свойства

protected Фабрика представлений	$views	Экземпляр фабрики представлений.
protected Swift_Mailer	$swift	Экземпляр Swift Mailer.
protected Диспечер событий	$events	Экземпляр диспечера событий.
protected массив	$from	Глобальный адрес и имя отправителя.
protected Запись в журнал	$logger	Экземпляр записывающего объекта журнала.
protected Контейнер	$container	Экземпляр контейнера IoC.
protected	$queue
protected логическое	$pretending	Указывает, отключено ли реальное отправление.
protected массив	$failedRecipients	Массив неудачных получателей.
protected массив	$parsedViews	Массив обработанных представлений, содержащий имена html и текстовых представлений.

Методы

void

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

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

void

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

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

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

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

addContent(Message $message, string $view, string $plain, 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(Writer $logger)

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

$this

setQueue(QueueManager $queue)

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

void

setContainer(Container $container)

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

Details

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

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

Parameters

Factory	$views
Swift_Mailer	$swift
Dispatcher	$events

Return Value

void

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

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

Parameters

string	$address
string	$name

Return Value

void

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

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

Parameters

string	$view
array	$data
mixed	$callback

Return Value

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 queueOn(string $queue, string|array $view, array $data, Closure|string $callback)

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

Параметры

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 addContent(Message $message, string $view, string $plain, array $data)

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

Параметры

Message	$message
string	$view
string	$plain
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(Writer $logger)

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

Параметры

Writer

$logger

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

$this

$this setQueue(QueueManager $queue)

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

Параметры

QueueManager

$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/4.2/Illuminate/Mail/Mailer.html