This gem allows you to store mail templates in the database.

db_mailer_rails works with Rails >= 4.1

Capabilities:

• Sending mails with ActionMailer::MessageDelivery (#deliver_now and #deliver_later methods)
• For replace values and logic in mail templates used Mustache
• To insert mail templates, use the configuration file(config/db_mailer_templates.yml) and task(rake db_mailer_rails:sync)
• Refactoring an existing project with sending mails is minimal

Add this line to your application's Gemfile:

gem 'db_mailer_rails'

And then execute:

$ bundle install

Next, you need to run the generator:

$ rails g db_mailer_rails:install

And also execute the created migration:

$ rake db:migrate

Syncing the configuration file(config/db_mailer_templates.yml) with database:

$ rake db_mailer_rails:sync

HelloWorldDbMailer.build(OpenStruct.new(name: 'YourApp')).deliver_now

HelloWorldDbMailer - this is the inheritance class of DbMailerRails::Base. It provides a mechanism for searching and rendering a template. All db_mailers need to inherit from it. All db_mailers are in the app /db_mailers folder.

1. Create app/db_mailers/test_db_mailer.rb with content:

   class TestDbMailer < DbMailerRails::Base
     def fields
       super.merge(current_year: 'Current year')
     end
     
     def current_year
       Time.current.year
     end
   end

2. Add the following lines to config/db_mailer_rails.yml:

   TestDbMailer:
     subject: This test email
     from: Site <no-reply@example.com>
     to: User <user@example.com>
     body: 'Hello, User! Current year is {{current_year}}'

3. Run task:

    $ rake db_mailer_rails:sync
   

4. Use db_mailer in your project:

   TestDbMailer.build.deliver_now

class TestDbMailer < DbMailerRails::Base
  attr_accessor :auth_token
  
  delegate :name, :email, to: :object, prefix: :user
  
  def build(object, **args)
    self.auth_token = args[:auth_token]
    super
  end
  
  def fields
    super.merge(
      user_name: 'User name',
      user_email: 'User email',
      auth_token: 'Auth token'
    )
  end
end

Sending a message with multiple attributes:

TestDbMailer.build(current_user, auth_token: 'qwerty123')

current_user - instance of User model with attributes name and email

The default template is app/views/layouts/mailer.html.erb.

To change the template for the db_mailer, you need to override method layout in your db_mailer:

def layout
  'custom_mail_template'
end

For the user to know what variables he can use in the template, you need helper db_mailer_rails_fields_render:

db_mailer_rails_fields_render(template)

template - instance of DbMailerTemplate

This helper render:

  <ul class="db_mailer__fields">
    <li class="db_mailer__field"><span>{{user_name}}</span> - User name</li>
    <li class="db_mailer__field"><span>{{user_email}}</span> - User e-mail</li>
  </ul>

After checking out the repo, run bundle to install dependencies. Then, run rake spec to run the tests.

Bug reports and pull requests are welcome on GitHub at https://github.com/alexhifer/db_mailer_rails. 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.

Everyone interacting in the db_mailer_rails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.