Spec-Zone.ru › Laravel 7

MailgunTransport

class MailgunTransport extends Transport (View source)

Свойства

массив $plugins

Зарегистрированные плагины для транспорта.

из Transport
protected ClientInterface $client

Экземпляр клиента Guzzle.

protected string $key

Ключ API Mailgun.

protected string $domain

Домен электронной почты Mailgun.

protected string $endpoint

Конечная точка API Mailgun.

Методы

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, string $domain, string|null $endpoint = null)

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

send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)

{@inheritdoc}

массив payload(Swift_Mime_SimpleMessage $message, string $to)

Получить HTTP-загрузку для отправки сообщения Mailgun.

string getTo(Swift_Mime_SimpleMessage $message)

Получить поле «to» для запроса API.

массив allContacts(Swift_Mime_SimpleMessage $message)

Получить всех контактов для сообщения.

string getMessageId(ResponseInterface $response)

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

string getKey()

Получить ключ API, используемый транспортом.

string setKey(string $key)

Установить ключ API, используемый транспортом.

string getDomain()

Получить домен, используемый транспортом.

string setDomain(string $domain)

Установить домен, используемый транспортом.

string getEndpoint()

Получить конечную точку API, используемую транспортом.

string setEndpoint(string $endpoint)

Установить конечную точку API, используемую транспортом.

Подробности

isStarted()

{@inheritdoc}

start()

{@inheritdoc}

stop()

{@inheritdoc}

ping()

{@inheritdoc}

void registerPlugin(Swift_Events_EventListener $plugin)

Зарегистрировать плагин для транспорта.

Параметры

Swift_Events_EventListener $plugin

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

void

protected void beforeSendPerformed(Swift_Mime_SimpleMessage $message)

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

Параметры

Swift_Mime_SimpleMessage $message

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

void

protected void sendPerformed(Swift_Mime_SimpleMessage $message)

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

Параметры

Swift_Mime_SimpleMessage $message

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

void

protected int numberOfRecipients(Swift_Mime_SimpleMessage $message)

Получить количество получателей.

Параметры

Swift_Mime_SimpleMessage $message

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

int

void __construct(ClientInterface $client, string $key, string $domain, string|null $endpoint = null)

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

Параметры

ClientInterface $client
string $key
string $domain
string|null $endpoint

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

void

send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)

{@inheritdoc}

Параметры

Swift_Mime_SimpleMessage $message
$failedRecipients

protected массив payload(Swift_Mime_SimpleMessage $message, string $to)

Получить HTTP-загрузку для отправки сообщения Mailgun.

Параметры

Swift_Mime_SimpleMessage $message
string $to

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

массив

protected string getTo(Swift_Mime_SimpleMessage $message)

Получить поле "to" для запроса API.

Параметры

Swift_Mime_SimpleMessage $message

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

string

protected array allContacts(Swift_Mime_SimpleMessage $message)

Получить все контакты для сообщения.

Параметры

Swift_Mime_SimpleMessage $message

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

array

protected string getMessageId(ResponseInterface $response)

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

Параметры

ResponseInterface $response

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

string

string getKey()

Получить API ключ, используемый транспортом.

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

string

string setKey(string $key)

Установить API ключ, используемый транспортом.

Параметры

string $key

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

string

string getDomain()

Получить домен, используемый транспортом.

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

string

string setDomain(string $domain)

Установить домен, используемый транспортом.

Параметры

string $domain

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

string

string getEndpoint()

Получить API конечную точку, используемую транспортом.

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

string

string setEndpoint(string $endpoint)

Установить API конечную точку, используемую транспортом.

Параметры

string $endpoint

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

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Mail/Transport/MailgunTransport.html

Spec-Zone.ru

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