Mailgun

Warning

If your site is using https and doesn’t have a valid certificate, then switch it to http while setting up Mailgun. Don’t forget to switch the site back to https and update the route when you have finished.

Configuration

Create a mailgun domain for your site (e.g. hatherleigh.info) and set-up the DNS records e.g:

Warning

If Mailgun asks you to create a TXT record with your domain name appended e.g. k1._domainkey.hatherleigh.info, then the name should be entered without the domain name e.g. k1._domainkey.

Using https://mailgun.com/cp/routes, create a route for your Mailgun domain (change hatherleigh.info to the domain name of your own site):

Priority              0
Filter Expressions    match_recipient(".*@hatherleigh.info")
Actions               forward("http://www.hatherleigh.info/mailgun/incoming/")

Note

As shown above, append /mailgun/incoming/ to your domain name.

If you want to forward the email to an existing account, just replace the action above with a simple forward to your email address e.g:

Actions               forward("you@yourbiz.co.uk")

Project

To integrate http://www.mailgun.com/ into your project…

Send email

Add the following to requirements/base.txt:

git+https://github.com/BradWhittington/django-mailgun.git#egg=django_mailgun

Add the following to settings/production.py:

# django-mailgun
EMAIL_BACKEND = 'django_mailgun.MailgunBackend'
MAILGUN_ACCESS_KEY = get_env_variable("MAILGUN_ACCESS_KEY")
MAILGUN_SERVER_NAME = get_env_variable("MAILGUN_SERVER_NAME")

Make sure you include a mailgun_access_key somewhere in your pillar.

Setting this as a global variable is probably a good idea because it will be the same for all your sites e.g:

mail:
  mailgun_access_key: 'your mailgun key'

In your Salt pillar for the site enable mailgun_send.

If the mailgun domain is different to the site domain add a mailgun_domain e.g:

sites:
  hatherleigh_net:
    domain: hatherleigh.net
    mail:
      mailgun_domain: mg.hatherleigh.net
      mailgun_receive: True
      mailgun_send: True

Receive email

If you want to receive mail, add the following to requirements/base.txt:

git+https://github.com/pkimber/django-mailgun-incoming.git#egg=mailgun_incoming

Add the following to THIRD_PARTY_APPS in settings/base.py:

'mailgun_incoming',

Add the following to project/urls.py:

urlpatterns = patterns(
    ...
    url(regex=r'^mailgun/',
        view=include('mailgun_incoming.urls')
        ),
    ...

In your Salt pillar for the site, enable mailgun_receive

Check the mailgun URL for your site (appending /mailgun/incoming/ to the site URL).

e.g using https://github.com/jkbr/httpie:

$ http GET http://hatherleigh.info/mailgun/incoming/
HTTP/1.1 405 METHOD NOT ALLOWED

See Process for notes on how to check incoming mail.

Warning

Don’t forget to leave the site set to https with the correct route before moving on…