Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Catch user-misspelled email addresses.
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
spec
.gitignore
CHANGELOG.md
Gemfile
LICENSE
README.md
Rakefile
mailcheck.gemspec

README.md

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 "user@hotnail.con", Mailcheck will suggest "user@hotmail.com".

Mailcheck will offer up suggestions for top level domains too, and suggest ".com" when a user types in "user@hotmail.cmo".

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("user@hotma.com")
# => {
#   :address =>"user",
#   :domain  =>"hotmail.com",
#   :full    =>"user@hotmail.com"
# }

Returns false if no suggestion:

> mailcheck.suggest("user@hotmail.com")
# => 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

Maintainers

License

Licensed under the MIT License.

Something went wrong with that request. Please try again.