SparkPostTransport
class SparkPostTransport extends Transport (View source)
Свойства
| массив | $plugins | Зарегистрированные плагины транспорта. | из Транспорта |
| protected ClientInterface | $client | Экземпляр клиента Guzzle. | |
| protected string | $key | Ключ API SparkPost. | |
| protected массив | $options | Параметры передачи SparkPost. |
Методы
| isStarted() {@inheritdoc} | из Транспорта | |
| start() {@inheritdoc} | из Транспорта | |
| stop() {@inheritdoc} | из Транспорта | |
| ping() {@inheritdoc} | из Транспорта | |
| void | registerPlugin(Swift_Events_EventListener $plugin) Зарегистрировать плагин в транспорте. | из Транспорта |
| void | beforeSendPerformed(Swift_Mime_SimpleMessage $message) Пройтись по зарегистрированным плагинам и выполнить их методы. | из Транспорта |
| void | sendPerformed(Swift_Mime_SimpleMessage $message) Пройтись по зарегистрированным плагинам и выполнить их методы. | из Транспорта |
| int | numberOfRecipients(Swift_Mime_SimpleMessage $message) Получить количество получателей. | из Транспорта |
| void | __construct(ClientInterface $client, string $key, array $options = []) Создать новый экземпляр транспорта SparkPost. | |
| send(Swift_Mime_SimpleMessage $message, $failedRecipients = null) {@inheritdoc} | ||
| массив | getRecipients(Swift_Mime_SimpleMessage $message) Получить все адреса, по которым должно быть отправлено это сообщение. Обратите внимание, что SparkPost по-прежнему учитывает заголовки CC, BCC в исходном сообщении. | |
| string | getTransmissionId(Response $response) Получить идентификатор передачи из ответа. | |
| string | getKey() Получить используемый ключ API транспорта. | |
| string | setKey(string $key) Установить используемый ключ API транспорта. | |
| string | getEndpoint() Получить конечную точку API SparkPost. | |
| массив | getOptions() Получить используемые параметры передачи транспорта. | |
| массив | setOptions(array $options) Установить используемые параметры передачи транспорта. |
Подробности
isStarted()
{@inheritdoc}
start()
{@inheritdoc}
stop()
{@inheritdoc}
ping()
{@inheritdoc}
void registerPlugin(Swift_Events_EventListener $plugin)
Зарегистрировать плагин в транспорте.
protected void beforeSendPerformed(Swift_Mime_SimpleMessage $message)
Пройтись по зарегистрированным плагинам и выполнить их методы.
protected void sendPerformed(Swift_Mime_SimpleMessage $message)
Пройтись по зарегистрированным плагинам и выполнить их методы.
protected int numberOfRecipients(Swift_Mime_SimpleMessage $message)
Получить количество получателей.
void __construct(ClientInterface $client, string $key, array $options = [])
Создать новый экземпляр транспорта SparkPost.
send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)
{@inheritdoc}
protected массив getRecipients(Swift_Mime_SimpleMessage $message)
Получить все адреса, по которым должно быть отправлено это сообщение.
Обратите внимание, что SparkPost по-прежнему учитывает заголовки CC, BCC в исходном сообщении.
protected string getTransmissionId(Response $response)
Получить идентификатор передачи из ответа.
string getKey()
Получить используемый ключ API транспорта.
string setKey(string $key)
Установить API ключ, используемый транспортом.
string getEndpoint()
Получить конечную точку API SparkPost.
array getOptions()
Получить параметры передачи, используемые транспортом.
array setOptions(array $options)
Установить параметры передачи, используемые транспортом.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Mail/Transport/SparkPostTransport.html
