lekoala/silverstripe-mandrill

Adds mandrill in the SilverStripe CMS

SilverStripe Mandrill module

, _(*1)

, _(*2)

, _(*3)

Use Mandrill in SilverStripe, _(*4)

Define in your .env file the following constant, _(*5)

MANDRILL_API_KEY='YOUR_API_KEY_HERE'

or by defining the api key in your config.yml, _(*6)

LeKoala\Mandrill\MandrillHelper:
    mandrill_api_key: "key3goes9here"

This module uses the official php sdk version 1.0.54 with a few tweaks., _(*7)

You can also autoconfigure the module with the following constants in your .env file, _(*8)

# Will log emails in the temp folders
MANDRILL_ENABLE_LOGGING=true
# Will disable sending (useful in development)
MANDRILL_SENDING_DISABLED=true
# Set app domain explicitly
MANDRILL_DOMAIN="mysite.co.nz"
# Also recommended to specify an explicit from
SS_SEND_ALL_EMAILS_FROM="noreply@mysite.co.nz"

By defining the Api Key, the module will register a new mailer that will be used to send all emails., _(*9)

Integration

This module create a new admin section that allows you to see results from your api calls right from the SilverStripe CMS without having to log into mandrillapp.com, _(*10)

Webhooks

From the Mandrill Admin, you can setup a webhook for your website. This webhook will be called and MandrillController will take care of handling all events for you., _(*11)

By default, MandrillController will do nothing. Feel free to add your own extensions to MandrillController to define your own rules, like "Send an email to the admin when we receive a spam complaint"., _(*12)

MandrillController provides 4 extensions points:, _(*13)

• updateHandleAnyEvent
• updateHandleSyncEvent
• updateHandleInboundEvent
• updateHandleMessageEvent

It's recommended that you ensure requests are coming from Mailchimp Transactional rather than an imitator. Webhook authentication is disabled by default but you can enable webhook authentication through the config layer like so:, _(*14)

LeKoala\Mandrill\MandrillController:
  webhook_auth_enabled: true

You'll need your webhook authentication key which you can view and reset from the (Webhooks)[https://mandrillapp.com/settings/webhooks] page in your account. Add your key using the config layer or .env file., _(*15)

via config, _(*16)

LeKoala\Mandrill\MandrillController:
  webhook_key: YOUR_KEY

via .env file, _(*17)

MANDRILL_WEBHOOK_KEY=YOUR_KEY

Migration from Swift Mailer

SilverStripe 5 replaced swift mailer by symfony/mailer, _(*18)

Make sure to read the docs https://docs.silverstripe.org/en/5/developer_guides/email/ https://symfony.com/doc/current/mailer.html, _(*19)

For SS4 version, check branch 3 and v4 releases, _(*20)

Compatibility

Tested with SilverStripe 5+, _(*21)

Maintainer

LeKoala - thomas@lekoala.be, _(*22)