/validates_email

validates_email is a Rails 4.2 and above plugin that validates email addresses against RFC 2822 and RFC 3696

Primary LanguageRubyMIT LicenseMIT

Gem Version Build Status Dependency Status

validates_email

validates_email is a Rails plugin that validates email addresses against RFC 2822 and RFC 3696

Installation

rails plugin install git://github.com/spectator/validates_email.git

or

gem 'spectator-validates_email', require: 'validates_email'

Usage

class User < ActiveRecord::Base
  validates :primary_email, email: true
end

As well as any other Rails validation this one has the same triggers, such as :on, :if, :unless, :allow_blank, and :allow_nil.

Also, you can pass your own custom error message.

class User < ActiveRecord::Base
  validates :primary_email, email: { message: 'is not an email address' }
end

If you like to check MX Records for email, you can use :mx option.

class User < ActiveRecord::Base
  validates :primary_email, email: { mx: true }
end

And if you like to check MX Records with fallback to A record, use :a_fallback option.

class User < ActiveRecord::Base
  validates :primary_email, email: { mx: { a_fallback: true } }
end

I18n

If you don't specify your own error message, then ActiveRecord's :invalid error message will be used to show the error.

If do check MX Records, then you have to specify your own error message or add it to your traslations:

activerecord:
  errors:
    messages:
      mx_invalid: "is not valid"

Credits

Most of the code were taken from Alex Dunae (dunae.ca) plugin (see http://github.com/alexdunae/validates_email_format_of/) and adopted for Rails 3 playing around with Rails 3 beta, so pass all beers to him.

Contributors

  • Petr Blaho
  • Christian Eichhorn
  • Alexander Zubkov
  • Daniel Naves de Carvalho
  • Aidan Coyle

How to contribute

  • Fork
  • Make changes
  • Write specs
  • Do pull request

Testing

To execute unit tests run rake spec within plugin folder.

The unit tests for this plugin use an in-memory sqlite3 database.

Notes

Compatible with the following ruby versions:

  • Ruby 2.2.x
  • Ruby 2.3.x
  • Ruby 2.4.x
  • Ruby 2.5.x

Compatible with the following Rails versions:

  • Rails 4.2.x
  • Rails 5.0.x
  • Rails 5.1.x
  • Rails 5.2.x