MailgunTransport
class MailgunTransport extends Transport (View source)
Properties
| array | $plugins | The plug-ins registered with the transport. |
from Transport |
| protected ClientInterface | $client | Guzzle client instance. |
|
| protected string | $key | The Mailgun API key. |
|
| protected string | $domain | The Mailgun email domain. |
|
| protected string | $endpoint | The Mailgun API endpoint. |
Methods
Register a plug-in with the transport.
Iterate through registered plugins and execute plugins' methods.
Iterate through registered plugins and execute plugins' methods.
Get the number of recipients.
Create a new Mailgun transport instance.
{@inheritdoc}
Get the HTTP payload for sending the Mailgun message.
Get the "to" payload field for the API request.
Get all of the contacts for the message.
Get the message ID from the response.
Get the API key being used by the transport.
Set the API key being used by the transport.
Get the domain being used by the transport.
Set the domain being used by the transport.
Get the API endpoint being used by the transport.
Set the API endpoint being used by the transport.
Details
bool
isStarted()
{@inheritdoc}
start()
{@inheritdoc}
stop()
{@inheritdoc}
bool
ping()
{@inheritdoc}
void
registerPlugin(Swift_Events_EventListener $plugin)
Register a plug-in with the transport.
protected void
beforeSendPerformed(Swift_Mime_SimpleMessage $message)
Iterate through registered plugins and execute plugins' methods.
protected void
sendPerformed(Swift_Mime_SimpleMessage $message)
Iterate through registered plugins and execute plugins' methods.
protected int
numberOfRecipients(Swift_Mime_SimpleMessage $message)
Get the number of recipients.
void
__construct(ClientInterface $client, string $key, string $domain, string|null $endpoint = null)
Create a new Mailgun transport instance.
int
send(Swift_Mime_SimpleMessage $message, $failedRecipients = null)
{@inheritdoc}
protected array
payload(Swift_Mime_SimpleMessage $message, string $to)
Get the HTTP payload for sending the Mailgun message.
protected string
getTo(Swift_Mime_SimpleMessage $message)
Get the "to" payload field for the API request.
protected array
allContacts(Swift_Mime_SimpleMessage $message)
Get all of the contacts for the message.
protected string
getMessageId(ResponseInterface $response)
Get the message ID from the response.
string
getKey()
Get the API key being used by the transport.
string
setKey(string $key)
Set the API key being used by the transport.
string
getDomain()
Get the domain being used by the transport.
string
setDomain(string $domain)
Set the domain being used by the transport.
string
getEndpoint()
Get the API endpoint being used by the transport.
string
setEndpoint(string $endpoint)
Set the API endpoint being used by the transport.