MailgunTransport

class MailgunTransport extends Transport (View source)

Свойства

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

Методы

bool

isStarted()

{@inheritdoc}

из Транспорта

start()

{@inheritdoc}

из Транспорта

stop()

{@inheritdoc}

из Транспорта

bool

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.

int

send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)

{@inheritdoc}

массив

payload(Swift_Mime_SimpleMessage $message, string $to)

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

строка

getTo(Swift_Mime_SimpleMessage $message)

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

массив

allContacts(Swift_Mime_SimpleMessage $message)

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

строка

getMessageId(ResponseInterface $response)

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

строка

getKey()

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

строка

setKey(string $key)

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

строка

getDomain()

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

строка

setDomain(string $domain)

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

строка

getEndpoint()

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

строка

setEndpoint(string $endpoint)

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

Подробности

bool isStarted()

{@inheritdoc}

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

bool

start()

{@inheritdoc}

stop()

{@inheritdoc}

bool ping()

{@inheritdoc}

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

bool

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
строка	$key
строка	$domain
строка\|null	$endpoint

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

void

int send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)

{@inheritdoc}

Параметры

Swift_Mime_SimpleMessage	$message
	$failedRecipients

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

int

protected array payload(Swift_Mime_SimpleMessage $message, string $to)

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

Параметры

Swift_Mime_SimpleMessage	$message
string	$to

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

array

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