Sparkpost-Rails5

Simple ActionMailer provider for sending mail through Sparkpost API.

Add this line to your application's Gemfile:

gem 'sparkpost_rails5', require: "sparkpost_rails"

And then execute:

$ bundle

Or install it yourself as:

$ gem install sparkpost_rails5

Add this to corresponding environment configuration file (config/environments/*.rb):

config.action_mailer.delivery_method = :sparkpost_rails

And make sure ENV['SPARKPOST_API_KEY'] is set.

You can also provide custom options through sparkpost_payload method. The value will be merged with request payload:

class UserMailer < ApplicationMailer

  def confirmation_email(email)
    sparkpost_payload(
      options: {
        open_tracking: true
      },
      campaign_id: "Your campaign ID"
      description: "Confirmation email",
      content: {
        headers: {
          "X-Custom-Header" => "custom header value"
        }
      }
    )
    mail(to: email, subject: "Confirm Your Account!!!")
  end

end

See https://developers.sparkpost.com/api/transmissions.html#transmissions-create

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/muhlisbc/sparkpost_rails5. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.