README.md

ValidEmail2

Validate emails with the help of the mail gem instead of some clunky regexp. Aditionally validate that the domain has a MX record. Optionally validate against a static list of disposable email services. Optionally validate that the email is not subaddressed (RFC5233).

Why?

There are lots of other gems and libraries that validates email addresses but most of them use some clunky regexp. I also saw a need to be able to validate that the email address is not coming from a "disposable email" provider.

Is it production ready?

Yes, it is used in several production apps.

Installation

Add this line to your application's Gemfile:

gem "valid_email2"

And then execute:

$ bundle

Or install it yourself as:

$ gem install valid_email2

Usage

Use with ActiveModel

If you just want to validate that it is a valid email address:

class User < ActiveRecord::Base
  validates :email, presence: true, 'valid_email_2/email': true
end

To validate that the domain has an MX record or A record:

validates :email, 'valid_email_2/email': { mx: true }

To validate strictly that the domain has an MX record:

validates :email, 'valid_email_2/email': { strict_mx: true }

strict_mx and mx both default to a 5 second timeout for DNS lookups.
To override this timeout, specify a dns_timeout option:

validates :email, 'valid_email_2/email': { strict_mx: true, dns_timeout: 10 }

Any checks that require DNS resolution will use the default Resolv::DNS nameservers for DNS lookups.
To override these, specify a dns_nameserver option:

validates :email, 'valid_email_2/email': { mx: true, dns_nameserver: ['8.8.8.8', '8.8.4.4'] }

To validate that the domain is not a disposable email (checks domain and MX server):

validates :email, 'valid_email_2/email': { disposable: true }

To validate that the domain is not a disposable email (checks domain only, does not check MX server):

validates :email, 'valid_email_2/email': { disposable_domain: true }

To validate that the domain is not a disposable email or a disposable email (checks domain and MX server) but allow-listed (under config/allow_listed_email_domains.yml):

validates :email, 'valid_email_2/email': { disposable_with_allow_list: true }

To validate that the domain is not a disposable email or a disposable email (checks domain only, does not check MX server) but allow-listed (under config/allow_listed_email_domains.yml):

validates :email, 'valid_email_2/email': { disposable_domain_with_allow_list: true }

To validate that the domain is not on the deny list (under config/deny_listed_email_domains.yml):

validates :email, 'valid_email_2/email': { deny_list: true }

To validate that email is not subaddressed:

validates :email, 'valid_email_2/email': { disallow_subaddressing: true }

To validate that email does not contain a dot anywhere before the @:

validates :email, 'valid_email_2/email': { disallow_dotted: true }

To validate create your own custom message:

validates :email, 'valid_email_2/email': { message: "is not a valid email" }

To allow multiple addresses separated by comma:

validates :email, 'valid_email_2/email': { multiple: true }

All together:

validates :email, 'valid_email_2/email': { mx: true, disposable: true, disallow_subaddressing: true}

Note that this gem will let an empty email pass through so you will need to add presence: true if you require an email

Use without ActiveModel

address = ValidEmail2::Address.new("lisinge@gmail.com")
address.valid? => true
address.disposable? => false
address.valid_mx? => true
address.valid_strict_mx? => true
address.subaddressed? => false

If you want to allow multibyte characters, set it explicitly.

ValidEmail2::Address.permitted_multibyte_characters_regex = /[ÆæØøÅåÄäÖöÞþÐð]/

Test environment

If you are validating mx then your specs will fail without an internet connection. It is a good idea to stub out that validation in your test environment.
Do so by adding this in your spec_helper:

config.before(:each) do
  allow_any_instance_of(ValidEmail2::Address).to receive_messages(
    valid_mx?: true,
    valid_strict_mx?: true,
    mx_server_is_in?: false
  )
end

Requirements

This gem is tested against currently supported Ruby and Rails versions. For an up to date list, check the build matrix in the workflow.

Upgrading to v5.3.0

In version v5.3.0 the config directory files were renamed as follows:

config/blacklisted_email_domains.yml -> config/deny_listed_email_domains.yml
config/whitelisted_email_domains.yml -> config/allow_listed_email_domains.yml

You won't need to make any changes yourself if you're installing this version for the first time. For individuals updating from earlier versions, make sure to update the file namings as per the above. In future versions this will be a breaking change.

Upgrading to v3.0.0

In version v3.0.0 I decided to move and rename the config files from the vendor directory to the config directory. That means:

vendor/blacklist.yml -> config/blacklisted_email_domains.yml
vendor/whitelist.yml -> config/whitelisted_email_domains.yml

The disposable validation has been improved with a mx check. Apply the stub, as noted in the Test environment section, if your tests have slowed down or if they do not work without an internet connection.

Upgrading to v2.0.0

In version 1.0 of valid_email2 we only defined the email validator.
But since other gems also define a email validator this can cause some unintended behaviours and emails that shouldn't be valid are regarded valid because the wrong validator is used by rails.

So in version 2.0 we decided to deprecate using the email validator directly and instead define a valid_email_2/email validator to be sure that the correct validator gets used.

So this:

validates :email, email: { mx: true, disposable: true }

Becomes this:

validates :email, 'valid_email_2/email': { mx: true, disposable: true }

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