challengepost-postmark

= Postmark gem

Ruby gem for sending emails through http://postmarkapp.com HTTP API

== Install

The gem is hosted at gemcutter. If you don't have it, install it first:

sudo gem install gemcutter

Then sudo gem install postmark

== Example

#!/usr/bin/env ruby

require 'rubygems'
require 'postmark'
require 'tmail'

Postmark.api_key = "your-api-key"

message = TMail::Mail.new
# make sure you have a sender signature with that email
# from and to also accept arrays of emails.
message.from = "[e-mail]"
message.to = "Sheldon Cooper <[e-mail]>"
message.subject = "Hi Sheldon!"
message.content_type = "text/html"
message.body = "Hello my friend!"
# set custom headers at will.
message["CUSTOM-HEADER"] = "my custom header value"
# tag message
message.tag = "my-tracking-tag"
# set reply to if you need; also, you can pass array of emails.
message.reply_to = "[e-mail]"

p Postmark.send_through_postmark(message).body

You can retrieve various information about your server state using the Public bounces API - http://developer.postmarkapp.com/bounces

# get delivery stats
Postmark.delivery_stats # json
Postmark::Bounce.all # [ bounce, bounce ... ]
bounce = Postmark::Bounce.find(bounce_id) # Bounce
bounce.dump # string, containing raw SMTP data
bounce.reactivate # reactivate hard bounce

== Encryption

To use SSL encryption when sending email configure the library as follows:

Postmark.secure = true

== Requirements

The gem relies on TMail for building the message. You will also need postmark account, server and sender signature set up to use it. If you plan using it in a rails project, check out the postmark-rails gem, which is meant to integrate with ActionMailer.

The plugin will try to use ActiveSupport Json if it is already included. If not, it will attempt using the built-in ruby Json library. You can also explicitly specify which one to be used, using

Postmark.response_parser_class = :Json # :ActiveSupport or :Yajl is also supported.

== Limitations

Currently postmark API does not support attachments. For more information, check the docs at:

http://developer.postmarkapp.com

== Note on Patches/Pull Requests

• Fork the project.
• Make your feature addition or bug fix.
• Add tests for it. This is important so I don't break it in a future version unintentionally.
• Commit, do not mess with rakefile, version, or history.
• Send me a pull request. Bonus points for topic branches.

== Copyright

Copyright (c) 2009 Wildbit LLC. See LICENSE for details.