Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,68 +1,3 @@ | ||
= bounce-email | ||
|
||
http://bounce-email.rubyforge.org/ | ||
|
||
== DESCRIPTION: | ||
|
||
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. | ||
|
||
== FEATURES/PROBLEMS: | ||
|
||
* Can't determine email address that bounced. | ||
|
||
== SYNOPSIS: | ||
|
||
Follow this tutorial to handle bounce-emails: http://keakaj.com/wisdom/2007/08/08/verp-on-rails/ | ||
|
||
Basic usage: | ||
require "rubygems" | ||
require "tmail" | ||
require "bounce_email" | ||
|
||
mail = TMail::Mail.parse(STDIN.read) # feed it the full text of an incoming message | ||
bounce = BounceEmail::Mail.new(mail) | ||
|
||
# Do something with bounce info | ||
bounce.isbounce # true/false | ||
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 | ||
|
||
== REQUIREMENTS: | ||
|
||
Ruby Gem TMail is required | ||
|
||
== INSTALL: | ||
|
||
Nothing to install. | ||
|
||
== CONTRIBUTIONS: | ||
|
||
http://github.com/whatcould/bounce-email/tree/master | ||
|
||
Please fork on github & add new conditions under "get_status_from_text" if you discover creative new mailserver responses. | ||
|
||
== LICENSE: | ||
|
||
(The MIT License) | ||
|
||
Copyright (c) 2009 Agris Ameriks | ||
|
||
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. | ||
This repository is out-of-date! Mitio picked up the ball here: https://github.com/mitio/bounce_email |