MailgunTransport

class MailgunTransport extends Transport (View source)

Свойства

массив	$plugins	Подключенные плагины к транспорту.	из Транспорта
защищённый ClientInterface	$client	Экземпляр клиента Guzzle.
защищённый строка	$key	Ключ API Mailgun.
защищённый строка	$domain	Домен электронной почты Mailgun.
защищённый строка	$endpoint	Конечная точка API Mailgun.

Методы

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

Создание нового экземпляра транспорта Mailgun.

send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)

{@inheritdoc}

массив

payload(Swift_Mime_SimpleMessage $message, string $to)

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

строка

getTo(Swift_Mime_SimpleMessage $message)

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

массив

allContacts(Swift_Mime_SimpleMessage $message)

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

строка

getMessageId(ResponseInterface $response)

Получение ID сообщения из ответа.

строка

getKey()

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

строка

setKey(string $key)

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

строка

getDomain()

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

строка

setDomain(string $domain)

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

строка

getEndpoint()

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

строка

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 array payload(Swift_Mime_SimpleMessage $message, string $to)

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

Параметры

Swift_Mime_SimpleMessage	$message
string	$to

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

массив

END_OF_DOCUMENT_MARKER

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/6.x/Illuminate/Mail/Transport/MailgunTransport.html