croby/simple_postmark

A simple way to use Postmark™ with your Rails app.

simple_postmark

SimplePostmark makes it easy to send mails via Postmark™ using Rails 3's ActionMailer. SimplePostmark is inspired by postmark-gem, but unfortunately postmark-gem forced to me to use non-standard Rails calls like postmark_attachments. SimplePostmark uses the standard Rails 3's ActionMailer syntax to send your emails via Postmark.

Tested against Ruby versions 1.9.2, 1.9.3, ruby-head and Rails versions 3.0.x, 3.1.x, 3.2.x, master (upcoming Rails 4.0.0).

If you are still using Ruby 1.8.7 or Ruby Enterprise Edition with Rails 3, you can use the backported version of this gem called simple_postmark18.

Installation

In your Gemfile:

group :production do
  gem 'simple_postmark'
end

In your config/environments/production.rb:

config.action_mailer.delivery_method = :simple_postmark
config.action_mailer.simple_postmark_settings = { api_key: '********-****-****-****-************' }

Usage

Just use your standard Rails 3 Mailer:

class NotificationMailer < ActionMailer::Base
  def notification
    mail(to: 'ted@himym.tld', from: 'barney@himym.tld', subject: "I'm your bro!") do
      # ...
    end
  end
end

And of course you can use standard attachment calls and Postmark's tags:

class NotificationMailer < ActionMailer::Base
  def notification
    attachments['thebrocode.pdf'] = File.read('thebrocode.pdf')
  
    mail(to: 'ted@himym.tld', from: 'barney@himym.tld', subject: "I'm your bro!", tag: 'with-attachment') do
      # ...
    end
  end
end

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Copyright

(The MIT license)

Copyright (c) 2011-2012 Mario Uher

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.