Mailthis
Description
Configure and send email using Mail (https://github.com/mikel/mail) over Net:SMTP.
Usage
A basic example
require 'mailthis'
GMAIL = Mailthis.mailer do
smtp_helo "example.com"
smtp_server "smtp.gmail.com"
smtp_port 587
smtp_user "[email protected]"
smtp_pw 'secret'
end
GMAIL.deliver do
subject 'a message for you'
to '[email protected]'
body 'here is a message for you'
end
A more complex example
require 'mailthis'
GMAIL = Mailthis.mailer do
smtp_helo "example.com"
smtp_server "smtp.gmail.com"
smtp_port 587
smtp_user "[email protected]"
smtp_pw 'secret'
smtp_auth "plain" # (optional) default: "login"
from "[email protected]" # (optional) default: config.smtp_username (if valid)
logger Logger.new("log/email.log") # (optional) default: no logger, no logging
end
msg = Mailthis::Message.new
msg.from = '[email protected]', # (optional) default: mailer #from
msg.reply_to = '[email protected]', # (optional) default: self #from
msg.to = "[email protected]",
msg.cc = "Another <[email protected]>",
msg.bcc = ["[email protected]", "Two <[email protected]>"],
msg.subject = "a message",
msg.body = "a message body"
GMAIL.deliver(msg)
Disable sending mail
You can disable actually sending mail (in tests, non-production envs, etc) by setting the MAILTHIS_DISABLE_SEND
environment variable. For example:
if !production?
# disable actually delivering emails when not in production
ENV['MAILTHIS_DISABLE_SEND'] = 'y'
end
Just set the env var to any not-nil value and mailthis will not send any mail. It will do everything else, however, including logging the mail it would have sent.
Installation
Add this line to your application's Gemfile:
gem 'mailthis'
And then execute:
$ bundle
Or install it yourself as:
$ gem install mailthis
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request