Skip to content
This repository was archived by the owner on Jan 31, 2020. It is now read-only.

Commit 614feca

Browse files
committed
Merge branch 'hotfix/141'
Closes #141
2 parents 2bcb038 + bbd5d5c commit 614feca

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

doc/book/validators/email-address.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,26 @@ at instantiation, by giving an array with the related options, or afterwards, by
3131
using `setOptions()`. The following options are supported:
3232

3333
- `allow`: Defines which type of domain names are accepted. This option is used
34-
in conjunction with the hostname option to set the hostname validator. For
35-
more information about possible values of this option, look at
36-
[Hostname](hostname.md) and possible `ALLOW_*` constants. This option
37-
defaults to `ALLOW_DNS`.
38-
- `deep`: Defines if the servers MX records should be verified by a deep check.
34+
in conjunction with the hostnameValidator option to set the hostname validator.
35+
Possible values of this option defined in [Hostname](hostname.md) validator's
36+
`ALLOW_*` constants:
37+
- `ALLOW_DNS` (default) - Allows Internet domain names _(e.g. example.com)_
38+
- `ALLOW_IP` - Allows IP addresses _(e.g. 192.168.0.1)_
39+
- `ALLOW_LOCAL` - Allows local network such as _localhost_ or _www.localdomain_
40+
- `ALLOW_URI` - Allows hostnames in URI generic syntax. See [RFC 3986](https://www.ietf.org/rfc/rfc3986.txt)
41+
- `ALLOW_ALL` - Allows all types of hostnames
42+
43+
- `useDeepMxCheck`: Defines if the servers MX records should be verified by a deep check.
3944
When this option is set to `true` then additionally to MX records also the `A`,
4045
`A6` and `AAAA` records are used to verify if the server accepts emails. This
4146
option defaults to `false`.
42-
- `domain`: Defines if the domain part should be checked. When this option is
47+
- `useDomainCheck`: Defines if the domain part should be checked. When this option is
4348
set to `false`, then only the local part of the email address will be checked.
4449
In this case the hostname validator will not be called. This option defaults
4550
to `true`.
46-
- `hostname`: Sets the hostname validator with which the domain part of the
47-
email address will be validated.
48-
- `mx`: Defines if the MX records from the server should be detected. If this
51+
- `hostnameValidator`: Sets the hostname validator object instance with which the
52+
domain part of the email address will be validated.
53+
- `useMxCheck`: Defines if the MX records from the server should be detected. If this
4954
option is defined to `true` then the MX records are used to verify if the
5055
server accepts emails. This option defaults to `false`.
5156

0 commit comments

Comments
 (0)