1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
# Valid Email
## Purpose
It validates email for application use (registering a new account for example).
## Usage
In your `Gemfile`:
```ruby
gem 'valid_email'
```
In your code:
```ruby
require 'valid_email'
class Person
include ActiveModel::Validations
attr_accessor :name, :email
validates :name, presence: true, length: { maximum: 100 }
validates :email, presence: true, email: true
end
person = Person.new
person.name = 'hallelujah'
person.email = 'john@doe.com'
person.valid? # => true
person.email = 'john@doe'
person.valid? # => false
person.email = 'John Does <john@doe.com>'
person.valid? # => false
```
You can check if email domain has MX record:
```ruby
validates :email,
email: {
mx: true,
message: I18n.t('validations.errors.models.user.invalid_email')
}
```
Or
```ruby
validates :email,
email: {
message: I18n.t('validations.errors.models.user.invalid_email')
},
mx: {
message: I18n.t('validations.errors.models.user.invalid_mx')
}
```
By default, the email domain is validated using a regular expression, which does not require an external service and improves performance.
Alternatively, you can check if an email domain has a MX or A record by using `:mx_with_fallback` instead of `:mx`.
```ruby
validates :email, email: { mx_with_fallback: true }
```
You can detect disposable accounts
```ruby
validates :email,
email: {
ban_disposable_email: true,
message: I18n.t('validations.errors.models.user.invalid_email')
}
```
If you don't want the MX validator stuff, just require the right file
```ruby
require 'valid_email/email_validator'
```
Or in your `Gemfile`
```ruby
gem 'valid_email', require: 'valid_email/email_validator'
```
### Usage outside of model validation
There is a chance that you want to use e-mail validator outside of model validation.
If that's the case, you can use the following methods:
```ruby
options = {} # You can optionally pass a hash of options, same as validator
ValidateEmail.valid?('email@randommail.com', options)
ValidateEmail.mx_valid?('email@randommail.com')
ValidateEmail.mx_valid_with_fallback?('email@randommail.com')
ValidateEmail.valid?('email@randommail.com')
```
Load it (and not the Rails extensions) with
```ruby
gem 'valid_email', require: 'valid_email/validate_email'
```
### String and Nil object extensions
There is also a String and Nil class extension, if you require the gem in this way in `Gemfile`:
```ruby
gem 'valid_email', require: 'valid_email/all_with_extensions'
```
You will be able to use the following methods:
```ruby
nil.email? # => false
'john@gmail.com'.email? # => May return true if it exists.
# It accepts a hash of options like ValidateEmail.valid?
```
## Code Status
[](https://travis-ci.org/hallelujah/valid_email)
## Credits
* Ramihajamalala Hery hery[at]rails-royce.org
* Fire-Dragon-DoL francesco.belladonna[at]gmail.com
* dush dusanek[at]iquest.cz
* MIke Carter mike[at]mcarter.me
* Heng heng[at]reamaze.com
* Marco Perrando mperrando[at]soluzioninrete.it
* Jörg Thalheim joerg[at]higgsboson.tk
* Andrey Deryabin deriabin[at]gmail.com
* Nicholas Rutherford nick.rutherford[at]gmail.com
* Oleg Shur workshur[at]gmail.com
* Joel Chippindale joel[at]joelchippindale.com
* Sami Haahtinen sami[at]haahtinen.name
* Jean Boussier jean.boussier[at]gmail.com
* Masaki Hara - @qnighy
## Pull Requests
1. Fork the project.
2. Make your feature addition or bug fix.
3. Add tests for it. This is important so I don’t break it in a future version unintentionally.
4. Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
5. Send me a pull request. Bonus points for topic branches.
## Copyright
Copyright © 2011 Ramihajamalala Hery. See LICENSE for details
|
