NSWDPC\Messaging\Mailgun\Connector\Event
Connector to handle Mailgun Event API request/response
- Author: James <james.ellis@dpc.nsw.gov.au>
Synopsis
class Event
extends Base
{
- // Inherited constants from Base
- const API_ENDPOINT_EU = 'https://api.eu.mailgun.net';
- // members
- protected array $results = ;
- // methods
- public array pollEvents()
- private void getNextPage()
- // Inherited methods from Base
- public static void DateTime()
- public void getClient()
- public void getApiEndpointRegion()
- public void getApiKey()
- public void getWebhookSigningKey()
- public void getWebhookFilterVariable()
- public void getWebhookPreviousFilterVariable()
- public void getWebhooksEnabled()
- public void getApiDomain()
- public void isSandbox()
- protected final void sendViaJob()
- protected final void alwaysSetSender()
- protected final void applyTestMode()
- public final void applyDefaultRecipient()
Hierarchy
Constants
Name | Value |
---|---|
API_ENDPOINT_EU | 'https://api.eu.mailgun.net' |
Members
protected
- $results
Methods
private
public
Inherited from NSWDPC\Messaging\Mailgun\Connector\Base
protected
- alwaysSetSender() — When true, the Sender header is always set to the From value. When false, use {@link NSWDPC\Messaging\Mailgun\MailgunMailer::setSender()} to set the Sender header as required
- applyTestMode() — Prior to any send/sendMime action, check config and set testmode if config says so
- sendViaJob() — Whether to send via a queued job or
public
- DateTime() — Returns an RFC2822 datetime in the format accepted by Mailgun
- applyDefaultRecipient() — When Bcc/Cc is provided with no 'To', mailgun rejects the request (400 Bad Request), this method applies the configured default_recipient
- getApiDomain()
- getApiEndpointRegion()
- getApiKey()
- getClient()
- getWebhookFilterVariable()
- getWebhookPreviousFilterVariable()
- getWebhookSigningKey()
- getWebhooksEnabled()
- isSandbox()