azendoo / griddler-mailgun

Mailgun adapter for the griddler gem.

Griddler::Mailgun

This was extracted from the griddler gem and is used to parse emails forwarded to your application from mailgun.

IMPORTANT: Please use version 1.0.1 or higher. There was a bug in version 1.0.0.

Installation

Add this line to your application's Gemfile:

gem 'griddler', '~> 1.0.0'
gem 'griddler-mailgun', '~> 1.0.1'

Then execute:

bundle install

Usage

Griddler comes with a route that, when used, handles the params passed to your application and then sends a Griddler::Email to EmailProcessor#process. Read a blog post about it on the Thoughtbot blog.

Getting mailgun to POST to your application

Mailgun uses routes to filter incoming emails and forward them to your app. A route is made up of a filter and an action. The filter matches emails based on its properties and the action determines what happens to the matched email.

For example, to forward any email sent to an example.net address to http://example.com/email_processor the following route would be used:

Filter Expression:

match_recipient(".*@example.net")

Action:

forward("http://example.com/email_processor")

More Information

• mailgun
• mailgun API - Routes
• mailgun User Maunual - Routes

Credits

Griddler::Mailgun was extracted from Griddler by Brad Pauly.

Griddler was written by Caleb Thompson and Joel Oliveira.

License

Griddler::Mailgun is Copyright © 2014 Brad Pauly. It is free software, and may be redistributed under the terms specified in the LICENSE file.