nswdpc/silverstripe-mailgun-sync

Send messages via Mailgun and synchronise with Mailgun Events API.

Installs: 4 550

Dependents: 1

Suggesters: 0

Security: 0

Stars: 1

Watchers: 3

Forks: 2

Open Issues: 2

Type:silverstripe-vendormodule

v1.0.5 2023-07-26 04:22 UTC

README

This module provides functionality to send emails via the Mailgun API and store events related to messages using Mailgun's webhooks feature

Requirements

See composer.json

  • silverstripe/framework ^4
  • Symbiote's Queued Jobs module
  • Mailgun PHP SDK ^3, kriswallsmith/buzz, nyholm/psr7

Mailgun configuration

You need:

  • A Mailgun account
  • At least one non-sandbox Mailgun mailing domain (verified is best) in your choice of region
  • A Mailgun API key or a Mailgun Domain Sending Key for the relevant mailing domain (the latter is recommended)
  • MailgunEmail and MailgunMailer are configured in your project (see below)

Installing

composer require nswdpc/silverstripe-mailgun-sync

Configuration

Mailgun account

Configuration of your Mailgun domain and account is beyond the scope of this document but is straightforward.

You should verify your domain to avoid message delivery issues. The best starting point is Verifying a Domain.

MXToolBox.com is a useful tool to check your mailing domain has valid DMARC records.

Module

Add the following to your project's yaml config:

---
Name: local-mailgunsync-config
After:
  - '#mailgunsync'
---
# API config
NSWDPC\Messaging\Mailgun\Connector\Base:
  # your Mailgun mailing domain
  api_domain: 'configured.mailgun.domain'
  # your API key or Domain Sending Key
  api_key: 'xxxx'
  # the endpoint region, if you use EU set this value to 'API_ENDPOINT_EU'
  # for the default region, leave empty
  api_endpoint_region: ''
  # this setting triggers o:testmode='yes' in messages
  api_testmode: true|false
  # You will probably want this as true, when false some clients will show 'Sent on behalf of' text
  always_set_sender: true
  # set this to override the From header, this is useful if your application sends out mail from anyone (see DMARC below)
  always_from: 'someone@example.com'
  # Whether to send via a job - see below
  send_via_job: 'yes|no|when-attachments'
  # When set, messages with no 'To' header are delivered here.
  default_recipient: ''
  # grab this from your Mailgun account control panel
  webhook_signing_key: ''
  # whether you want to store webhook requests
  webhooks_enabled: true|false
  # the current or new filter variable (see webhooks documentation in ./docs)
  webhook_filter_variable: ''
  # the previous one, to allow variable rotation
  webhook_previous_filter_variable: ''
---
# Configure the mailer
Name: local-mailer
After:
  # Override core email configuration
  - '#emailconfig'
---
# Send messages via the MailgunMailer
SilverStripe\Core\Injector\Injector:
  SilverStripe\Control\Email\Email:
    class: 'NSWDPC\Messaging\Mailgun\MailgunEmail'  
  SilverStripe\Control\Email\Mailer:
    class: 'NSWDPC\Messaging\Mailgun\MailgunMailer'

Remember to flush configuration after a configuration change.

See detailed configuration, including project tags

Sending

Mailer

For a good example of this, look at the MailgunSyncTest class. Messages are sent using the default Silverstripe Email API:

use SilverStripe\Control\Email\Email;

$email = Email::create();
$email->setFrom($from);
$email->setTo($to);
$email->setSubject($subject);

To add custom parameters used by Mailgun you call setCustomParameters():

// variables
$variables = [
    'test' => 'true',
    'foo' => 'bar',
];

//options
$options = [
    'testmode' => 'yes',
    'tag' => ['tag1','tag2','tag4'],
    'tracking' => 'yes',
    'require-tls' => 'yes'
];

// headers
$headers = [
    'X-Test-Header' => 'testing'
];

$recipient_variables = [
    'someone@example.com' => ["unique_id" => "testing_123"]
];

$args = [
    'options' => $options,
    'variables' => $variables,
    'headers' => $headers,
    'recipient-variables' => $recipient_variables
];

$email->setCustomParameters($args)

Where $args is an array of your custom parameters. Calling setCustomParameters() multiple times will overwrite previous parameters.

Send the message:

$response = $email->send();

The response will either be a Mailgun message-id OR a Symbiote\QueuedJobs\DataObjects\QueuedJobDescriptor instance if you are sending via the queued job.

Via API connector

You can send directly via the API connector, which handles client setup and the like based on configuration. For a good example of this, look at the MailgunMailer class

use NSWDPC\Messaging\Mailgun\Connector\Message;

//set parameters
$parameters = [
    'to' => ...,
    'from' => ...,
    'o:tag' => ['tag1','tag2']
    // etc
];
$connector = Message::create();
$response = $connector->send($parameters);

The response will either be a Mailgun message-id OR a Symbiote\QueuedJobs\DataObjects\QueuedJobDescriptor instance if you are sending via the queued job.

Direct to Mailgun PHP SDK

If you like, you can send messages and interact with the Mailgun API via the Mailgun PHP SDK:

use Mailgun\Mailgun;

$client = Mailgun::create($api_key);
// set things up then send
$response = $client->messages()->send($domain, $parameters);

The response will be a Mailgun\Model\Message\SendResponse instance if successful.

See the Mailgun PHP SDK documentation for examples.

Queued Jobs

The module uses the Queued Jobs module to deliver email at a later time.

This way, a website request that involves delivering an email will not be held up by API issues.

SendJob

This is a queued job that can be used to send emails depending on the send_via_job config value -

  • 'yes' - all the time
  • 'when-attachments' - only when attachments are present, or
  • 'no' - never (in which case messages will never send via a Queued Job)

Messages are handed off to this queued job, which is configured to send after one minute. Once delivered, the message parameters are cleared to reduce space used by large messages.

This job is marked as 'broken' immediately upon an API or other general error. Please read the Queued Jobs Health Check documentation to get assistance with Broken job reporting.

TruncateJob

Use this job to clear out older MailgunEvent webhook records. If you don't use webhooks to store events, this job can remain unused.

RequeueJob

Use this job to kick broken SendJob instances, which happen from time-to-time due to API or connectivity issues.

This job will:

  1. Take all job descriptor records for SendJob that are Broken
  2. Reset their status, processing counts and worker value to default initial values
  3. Set them to start after a minute
  4. Save the record

On the next queue run, these jobs will attempt to send again.

Manual Resubmission

Messages can be resent from the Mailgun control panel. This depends on your Message Retention setting for the relevant mailing domain in Mailgun.

DMARC considerations

When sending email it's wise to consider how you maintain the quality of your mailing domain (and IP(s)).

If your mailing domain is "mg.example.com" and you send "From: someone@example.net" DMARC rules will most likely kick in at the recipient mail server and your message will be quarantined or rejected (unless example.net designates example.com as a permitted sender). Instead, use a From header of "someone@mg.example.com" or "someone@example.com" in your messages.

Your Reply-To header can be any valid address.

See dmarc.org for more information on the importance of DMARC, SPF and DKIM

Tests

Unit tests: ./tests. Tests use the TestMessage connector.

Sending emails using sandbox/testmode

For acceptance testing, you can use a combination of the Mailgun sandbox domain and API testmode.

  • Sandbox domain: set the api_domain value in configuration to the sandbox domain provided by Mailgun. Remember to list approved recipients in the sandbox domain settings in the Mailgun control panel.
  • Test mode: set the api_testmode value to true. In testmode, Mailgun accepts but does not deliver messages.

Breaking changes in 1.0 release

Version 1 removed unused features to reduce the complexity of this module.

The core functionality is now:

  • Send messages via the standard Email process in Silverstripe, with added Mailgun options
  • Send messages directly via the API
  • Handle webhook requests from Mailgun via a dedicated controller

Synchronisation of events is now handled by the webhooks controller

LICENSE

BSD-3-Clause

See LICENSE

Maintainers

Bugtracker

We welcome bug reports, pull requests and feature requests on the Github Issue tracker for this project.

Please review the code of conduct prior to opening a new issue.

Security

If you have found a security issue with this module, please email digital[@]dpc.nsw.gov.au in the first instance, detailing your findings.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

Please review the code of conduct prior to completing a pull request.