isabella232 / mailcheck-ruby

Reduce misspelled email addresses in Ruby.

mailcheck-ruby

The Ruby library that suggests a right domain when your users misspell it in an email address. See the original at https://github.com/mailcheck/mailcheck.

When your user types in "[email protected]", Mailcheck will suggest "[email protected]".

Mailcheck will offer up suggestions for top level domains too, and suggest ".com" when a user types in "[email protected]".

mailcheck-ruby is part of the Mailcheck family, and we're always on the lookout for more ports and adaptions. Get in touch!

Installation

Add this line to your application's Gemfile:

gem 'mailcheck'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mailcheck

Usage

> require 'mailcheck'

> mailcheck = Mailcheck.new
> mailcheck.suggest("[email protected]")
# => {
#   :address =>"user",
#   :domain  =>"hotmail.com",
#   :full    =>"[email protected]"
# }

Returns false if no suggestion:

> mailcheck.suggest("[email protected]")
# => false

Pass in a custom list of domains and TLDs:

mailcheck = Mailcheck.new(
  :domains => ["gmail.com", "hotmail.com", "aol.com"],
  :top_level_domains => ["com", "net", "org"]
)

Contributing

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

Credits

• This gist, by mmmaia - an initial port to Ruby

Maintainers

• Scott Becker, Author.

License

Licensed under the MIT License.