Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.61 KB

README.md

File metadata and controls

59 lines (36 loc) · 1.61 KB

mailgun_rails

mailgun_rails is an Action Mailer adapter for using Mailgun in Rails apps. It uses the Mailgun HTTP API internally.

Installing

In your Gemfile

gem 'mailgun_rails'

Usage

To configure your Mailgun credentials place the following code in the corresponding environment file (development.rb, production.rb...)

config.action_mailer.delivery_method = :mailgun
config.action_mailer.mailgun_settings = {
		api_key: '<mailgun api key>',
		domain: '<mailgun domain>'
}

Now you can send emails using plain Action Mailer:

email = mail from: '[email protected]', to: '[email protected]', subject: 'this is an email'

Mailgun variables

email.mailgun_variables = {name_1: :value_1, name_2: value_2}

Recipient Variables (for batch sending)

email.mailgun_recipient_variables = {'[email protected]' => {id: 1}, '[email protected]' => {id: 2}}

Custom MIME headers

email.mailgun_headers = {foo: 'bar'}

Pending

  • Sending attachments

Pull requests are welcomed

A NOTE ABOUT TESTING PLEASE READ: with caching enabled, the deliverer instance at the rails level is cached. therefore, since we're changing configs in the test suite, we need to make sure we use Hermes::Deliverer.new(@settings).deliver!(mail_msg) to avoid the caching behavior issues