Enkimail Ruby Gem

enkimail is the official gem for integrating Enkimail transactional email service with Ruby on Rails. It allows you to send emails using Enkimail's infrastructure simply by configuring the ActionMailer delivery_method.

• Native Rails Integration: Automatically registers as an ActionMailer delivery method.
• Multipart Support: Automatically handles HTML and plain text email bodies.
• Attachments: Built-in support for sending attachments (automatically Base64 encoded for the API).
• Flexible Configuration: Allows defining a base_url for testing in development or staging environments.

Add this line to your application's Gemfile:

gem 'enkimail'

And then execute:

$ bundle install

Or install it manually:

$ gem install enkimail

Before using the gem, ensure that:

1. Verified Domain: Your sending domain must be verified in the Enkimail dashboard.
2. Verified Sender: The from email address you use must be a verified sender in your Enkimail account.

Emails sent from unverified domains or senders will be rejected by the API.

To use Enkimail as your email provider, edit your environment configuration file (e.g., config/environments/production.rb):

Rails.application.configure do
  # ...
  config.action_mailer.delivery_method = :enkimail
  config.action_mailer.enkimail_settings = {
    api_key: ENV['ENKIMAIL_API_KEY']
  }

  # Optional: Configure a global 'from' address
  # This address MUST be a verified sender in your Enkimail dashboard.
  config.action_mailer.default_options = { from: 'no-reply@yourdomain.com' }
end

You can set the from address globally in your ApplicationMailer or specifically in each mailer method. Remember that Enkimail requires the sender to be verified.

class ApplicationMailer < ActionMailer::Base
  default from: 'info@yourdomain.com'
  layout 'mailer'
end

class UserMailer < ApplicationMailer
  def welcome_email(user)
    @user = user
    mail(
      to: @user.email,
      subject: 'Welcome to Enkimail',
      from: 'onboarding@yourdomain.com' # Must be a verified sender
    )
  end
end

The gem handles attachment processing automatically:

def invoice_email(user, invoice_pdf)
  attachments['invoice.pdf'] = invoice_pdf
  mail(to: user.email, subject: 'Your Invoice')
end

If you are developing the Enkimail API locally and want to test the gem against your local Rails instance, you can configure the base_url:

# config/environments/development.rb
config.action_mailer.delivery_method = :enkimail
config.action_mailer.enkimail_settings = {
  api_key: 'test_key',
  base_url: 'http://localhost:3000'
}

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