Maildotyml
Configure ActionMailer with mail.yml, like ActiveRecord and database.yml.
Installation
Add this line to your application's Gemfile:
gem 'maildotyml'
And then execute:
$ bundle
To install an example mail.yml, run:
$ rails generate maildotyml:install
Usage
Add a config/mail.yml
to your project.
Here is an example to get you started:
development:
adapter: :smtp
address: 'localhost'
port: 25
domain: 'localhost.localdomain'
enable_startttls_auto: true
test:
adapter: :test
production:
adapter: :smtp
# Note that some standard activerecord options are automatically translated.
host: 'your.smtp.server'
port: 25
authentication: 'login'
domain: 'your.domain-to.authenticate-to.smtp.com'
username: <%= ENV['MAIL_USERNAME'] %>
password: <%= ENV['MAIL_PASSWORD'] %>
enable_startttls_auto: true
ActiveRecord style keys
In order to be more like ActiveRecord configuration, maildotyml automatically
maps some configuration keys. For example, ActiveRecord expects a username
for
database connection. ActionMailer expects user_name
for smtp configuration.
With maildotyml, either will work.
Supported mappings
-
username
->user_name
-
host
->address
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request