Rails Courrier

Rails-specific features for Courrier, the API-powered email delivery gem for Ruby.

Sponsored By Rails Designer

Add to your Gemfile:

bundle add rails_courrier

Generate the initializer:

bin/rails generate courrier:install

This creates config/initializers/courrier.rb.

Generate an email:

bin/rails generate courrier:email Order

This creates app/emails/order_email.rb.

Mount the engine for inbox previews:

# config/routes.rb
mount Courrier::Engine => "/courrier"

OrderEmail.deliver to: "recipient@railsdesigner.com"

OrderEmail.deliver_later to: "recipient@railsdesigner.com"

Configure queue options in the email class:

class OrderEmail < Courrier::Email
  enqueue queue: "emails", wait: 5.minutes

  def subject = "Your order is ready!"
  # …
end

Preview emails in your browser:

# config/initializers/courrier.rb
Courrier.configure do |config|
  config.email = { provider: "inbox" }
end

Enable auto-open:

config.email = { provider: "inbox" }
config.inbox.auto_open = true

Clear inbox files:

bin/rails courrier:clear

Rails Courrier automatically includes Rails URL helpers in your email classes:

class OrderEmail < Courrier::Email
  def text
    "View your order: #{order_url(token: "abc123")}"
  end
end

See the Courrier README for full configuration, providers, layouts, templates and more.

This project uses Standard for formatting Ruby code. Please make sure to run rake before submitting pull requests.

Courrier is released under the MIT License.