README.md in bounce_email-0.2.2 vs README.md in bounce_email-0.2.3

- old
+ new

@@ -1,9 +1,11 @@ # bounce-email This Ruby library is for determining the bounce type of an email message. It determines whether the bounce is hard or soft, if is an "out of office mail", etc. +[![Build Status](https://api.travis-ci.org/livebg/bounce_email.png)](https://travis-ci.org/livebg/bounce_email) + ## SYNOPSIS: Follow this tutorial to handle bounce-emails: [http://keakaj.com/wisdom/2007/08/08/verp-on-rails](http://keakaj.com/wisdom/2007/08/08/verp-on-rails/) Basic usage: @@ -17,26 +19,35 @@ bounce.code # e.g. "5.1.1" bounce.reason # e.g. "Something about the address specified in the message caused this DSN." bounce.type # "Permanent Failure", "Persistent Transient Failure", "Success" -- BounceEmail::TYPE_HARD_FAIL, TYPE_SOFT_FAIL, TYPE_SUCCESS +## Compatibility + +Compatible with Ruby 1.9.x, 2.0.0, 2.1.0, and 2.2.0. + +It is no longer tested under 1.8.7, but it should work there as well, if you use it with an older version of the `mime-types` gem (from the 1.x branch). `mime-types` is a dependency of the `mail` gem, which currently works with `mime-types` 1.6+, so it should be possible. + ## REQUIREMENTS: -Ruby 1.9 & Ruby Gem Mail is required. The gem is used for primary bounce handling, which catches about 50% of all bounces. -For most other bounces, this gem comes in. See discussion here: [https://github.com/mikel/mail/issues/103](https://github.com/mikel/mail/issues/103) +[mail](http://rubygems.org/gems/mail) gem is required with `bounce_email` gem. +The `mail` gem is used for primary bounce handling, which catches about 50% of +all bounces. `bounce_email` tries to catch remaining bounce emails. +See discussion here: [https://github.com/mikel/mail/issues/103](https://github.com/mikel/mail/issues/103) + ## Other implementations: * (PERL) [https://github.com/rjbs/mail-deliverystatus-bounceparser](https://github.com/rjbs/mail-deliverystatus-bounceparser) ## TODO: - * code cleanup!!! Oh yes! - * don't hardcode comparison strings, move to external file which can be extended easily - * more test: extend for more bounces - * is OUT of office type needed? if yes implement as optional part - * merge into Mail Gem?? + * Mode code cleanup. + * Don't hardcode comparison strings, move to external file which can be extended easily. + * More test: extend for more bounces. + * Is OUT of office type needed? If yes, implement as an optional part. + * Merge into Mail Gem? ## CONTRIBUTIONS: Please fork on github & add new conditions under "get_status_from_text" if you discover creative new mailserver responses.