@@ -31,21 +31,26 @@ at instantiation, by giving an array with the related options, or afterwards, by
31
31
using ` setOptions() ` . The following options are supported:
32
32
33
33
- ` 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.
39
44
When this option is set to ` true ` then additionally to MX records also the ` A ` ,
40
45
` A6 ` and ` AAAA ` records are used to verify if the server accepts emails. This
41
46
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
43
48
set to ` false ` , then only the local part of the email address will be checked.
44
49
In this case the hostname validator will not be called. This option defaults
45
50
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
49
54
option is defined to ` true ` then the MX records are used to verify if the
50
55
server accepts emails. This option defaults to ` false ` .
51
56
0 commit comments