README.md

Postal for the Mail Gem

This allows you to easily deliver messages through Postal using the Ruby mail gem.

Installation

Add the gems to your Gemfile and run bundle install.

gem 'mail'
gem 'postal-mailgem'

Configuraton

You can set the delivery method globally to use Postal.

Mail.defaults do
  delivery_method :postal, :host => 'https://postal.yourdomain.com', :server_key => 'xxx'
end

Or, you can configure it on a per message basis:

message = Mail.new
message.to "[email protected]"
message.from "[email protected]"
message.body "Hello there!"
message.delivery_method :postal, :host => 'https://postal.yourdomain.com', :server_key => 'xxx'
message.deliver

You don't need to specify a server_key or host if you have set the POSTAL_KEY and POSTAL_HOST environment variables.