You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -30,7 +30,71 @@ An API key is required for this module to function.
30
30
Go to https://www.mailboxvalidator.com/plans#api to sign up for FREE API plan and you'll be given an API key.
31
31
32
32
33
-
Usage for validating emails
33
+
Functions
34
+
=========
35
+
36
+
## SingleValidation (api_key)
37
+
38
+
Creates a new instance of the MailboxValidator object with the API key.
39
+
40
+
## ValidateEmail (email_address)
41
+
42
+
Performs email validation on the supplied email address.
43
+
44
+
## Return Fields
45
+
46
+
| Field Name | Description |
47
+
|-----------|------------|
48
+
| email_address | The input email address. |
49
+
| domain | The domain of the email address. |
50
+
| is_free | Whether the email address is from a free email provider like Gmail or Hotmail. Return values: True, False |
51
+
| is_syntax | Whether the email address is syntactically correct. Return values: True, False |
52
+
| is_domain | Whether the email address has a valid MX record in its DNS entries. Return values: True, False, - (- means not applicable) |
53
+
| is_smtp | Whether the mail servers specified in the MX records are responding to connections. Return values: True, False, - (- means not applicable) |
54
+
| is_verified | Whether the mail server confirms that the email address actually exist. Return values: True, False, - (- means not applicable) |
55
+
| is_server_down | Whether the mail server is currently down or unresponsive. Return values: True, False, - (- means not applicable) |
56
+
| is_greylisted | Whether the mail server employs greylisting where an email has to be sent a second time at a later time. Return values: True, False, - (- means not applicable) |
57
+
| is_disposable | Whether the email address is a temporary one from a disposable email provider. Return values: True, False, - (- means not applicable) |
58
+
| is_suppressed | Whether the email address is in our blacklist. Return values: True, False, - (- means not applicable) |
59
+
| is_role | Whether the email address is a role-based email address like [email protected] or [email protected]. Return values: True, False, - (- means not applicable) |
60
+
| is_high_risk | Whether the email address contains high risk keywords. Return values: True, False, - (- means not applicable) |
61
+
| is_catchall | Whether the email address is a catch-all address. Return values: True, False, Unknown, - (- means not applicable) |
62
+
| mailboxvalidator_score | Email address reputation score. Score > 0.70 means good; score > 0.40 means fair; score <= 0.40 means poor. |
63
+
| time_taken | The time taken to get the results in seconds. |
64
+
| status | Whether our system think the email address is valid based on all the previous fields. Return values: True, False |
65
+
| credits_available | The number of credits left to perform validations. |
66
+
| error_code | The error code if there is any error. See error table in the below section. |
67
+
| error_message | The error message if there is any error. See error table in the below section. |
68
+
69
+
## DisposableEmail (email_address)
70
+
71
+
Check if the supplied email address is from a disposable email provider.
72
+
73
+
## Return Fields
74
+
75
+
| Field Name | Description |
76
+
|-----------|------------|
77
+
| email_address | The input email address. |
78
+
| is_disposable | Whether the email address is a temporary one from a disposable email provider. Return values: True, False |
79
+
| credits_available | The number of credits left to perform validations. |
80
+
| error_code | The error code if there is any error. See error table in the below section. |
81
+
| error_message | The error message if there is any error. See error table in the below section. |
82
+
83
+
## FreeEmail (email_address)
84
+
85
+
Check if the supplied email address is from a free email provider.
86
+
87
+
## Return Fields
88
+
89
+
| Field Name | Description |
90
+
|-----------|------------|
91
+
| email_address | The input email address. |
92
+
| is_free | Whether the email address is from a free email provider like Gmail or Hotmail. Return values: True, False |
93
+
| credits_available | The number of credits left to perform validations. |
94
+
| error_code | The error code if there is any error. See error table in the below section. |
95
+
| error_message | The error message if there is any error. See error table below. |
96
+
97
+
Sample codes to validate email
34
98
===========================
35
99
36
100
```php
@@ -73,130 +137,8 @@ else {
73
137
?>
74
138
```
75
139
76
-
Functions
77
-
=========
78
-
79
-
### SingleValidation(api_key)
80
-
81
-
Creates a new instance of the MailboxValidator object with the API key.
82
-
83
-
### ValidateEmail(email_address)
84
-
85
-
Performs email validation on the supplied email address.
86
-
87
-
Result Fields
88
-
=============
89
-
90
-
### email_address
91
-
92
-
The input email address.
93
-
94
-
### domain
95
-
96
-
The domain of the email address.
97
-
98
-
### is_free
99
-
100
-
Whether the email address is from a free email provider like Gmail or Hotmail.
101
-
102
-
Return values: True, False
103
-
104
-
### is_syntax
105
-
106
-
Whether the email address is syntactically correct.
107
-
108
-
Return values: True, False
109
-
110
-
### is_domain
111
-
112
-
Whether the email address has a valid MX record in its DNS entries.
113
-
114
-
Return values: True, False, - (- means not applicable)
115
-
116
-
### is_smtp
117
-
118
-
Whether the mail servers specified in the MX records are responding to connections.
119
-
120
-
Return values: True, False, - (- means not applicable)
121
-
122
-
### is_verified
123
-
124
-
Whether the mail server confirms that the email address actually exist.
125
-
126
-
Return values: True, False, - (- means not applicable)
127
-
128
-
### is_server_down
129
-
130
-
Whether the mail server is currently down or unresponsive.
131
-
132
-
Return values: True, False, - (- means not applicable)
133
-
134
-
### is_greylisted
135
-
136
-
Whether the mail server employs greylisting where an email has to be sent a second time at a later time.
137
-
138
-
Return values: True, False, - (- means not applicable)
139
-
140
-
### is_disposable
141
-
142
-
Whether the email address is a temporary one from a disposable email provider.
143
-
144
-
Return values: True, False, - (- means not applicable)
145
-
146
-
### is_suppressed
147
-
148
-
Whether the email address is in our blacklist.
149
-
150
-
Return values: True, False, - (- means not applicable)
0 commit comments