SparkPostTransport
класс SparkPostTransport расширяет Transport (Просмотр исходного кода)
Свойства
| массив | $plugins | Зарегистрированные плагины в транспорте. | из Transport |
| защищённый ClientInterface | $client | Экземпляр клиента Guzzle. | |
| защищённый string | $key | Ключ API SparkPost. | |
| защищённый массив | $options | Параметры отправки SparkPost. |
Методы
| isStarted() {@inheritdoc} | из Transport | |
| start() {@inheritdoc} | из Transport | |
| stop() {@inheritdoc} | из Transport | |
| ping() {@inheritdoc} | из Transport | |
| void | registerPlugin(Swift_Events_EventListener $plugin) Зарегистрировать плагин в транспорте. | из Transport |
| void | beforeSendPerformed(Swift_Mime_SimpleMessage $message) Пройтись по зарегистрированным плагинам и выполнить их методы. | из Transport |
| void | sendPerformed(Swift_Mime_SimpleMessage $message) Пройтись по зарегистрированным плагинам и выполнить их методы. | из Transport |
| int | numberOfRecipients(Swift_Mime_SimpleMessage $message) Получить количество получателей. | из Transport |
| 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 array 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.7/Illuminate/Mail/Transport/SparkPostTransport.html
