@@ -26,8 +26,8 @@ An API key is required for this class to function.
2626
2727Go to http://www.mailboxvalidator.com/plans#api to sign up for a FREE API plan and you'll be given an API key.
2828
29- Sample Usage
30- ============
29+ Usage
30+ =====
3131
3232``` java
3333import com.mailboxvalidator.* ;
@@ -80,6 +80,140 @@ public class Main
8080}
8181```
8282
83+ Functions
84+ =========
85+
86+ ### SingleValidation(api_key)
87+
88+ Creates a new instance of the MailboxValidator object with the API key.
89+
90+ ### ValidateEmail(email_address)
91+
92+ Performs email validation on the supplied email address.
93+
94+ Result Fields
95+ =============
96+
97+ ### email_address
98+
99+ The input email address.
100+
101+ ### domain
102+
103+ The domain of the email address.
104+
105+ ### is_free
106+
107+ Whether the email address is from a free email provider like Gmail or Hotmail.
108+
109+ Return values: True, False
110+
111+ ### is_syntax
112+
113+ Whether the email address is syntactically correct.
114+
115+ Return values: True, False
116+
117+ ### is_domain
118+
119+ Whether the email address has a valid MX record in its DNS entries.
120+
121+ Return values: True, False, -  ;  ;  ; (- means not applicable)
122+
123+ ### is_smtp
124+
125+ Whether the mail servers specified in the MX records are responding to connections.
126+
127+ Return values: True, False, -  ;  ;  ; (- means not applicable)
128+
129+ ### is_verified
130+
131+ Whether the mail server confirms that the email address actually exist.
132+
133+ Return values: True, False, -  ;  ;  ; (- means not applicable)
134+
135+ ### is_server_down
136+
137+ Whether the mail server is currently down or unresponsive.
138+
139+ Return values: True, False, -  ;  ;  ; (- means not applicable)
140+
141+ ### is_greylisted
142+
143+ Whether the mail server employs greylisting where an email has to be sent a second time at a later time.
144+
145+ Return values: True, False, -  ;  ;  ; (- means not applicable)
146+
147+ ### is_disposable
148+
149+ Whether the email address is a temporary one from a disposable email provider.
150+
151+ Return values: True, False, -  ;  ;  ; (- means not applicable)
152+
153+ ### is_suppressed
154+
155+ Whether the email address is in our blacklist.
156+
157+ Return values: True, False, -  ;  ;  ; (- means not applicable)
158+
159+ ### is_role
160+
161+ Whether the email address is a role-based email address like
[email protected] or
[email protected] .
162+
163+ Return values: True, False, -  ;  ;  ; (- means not applicable)
164+
165+ ### is_high_risk
166+
167+ Whether the email address contains high risk keywords.
168+
169+ Return values: True, False, -  ;  ;  ; (- means not applicable)
170+
171+ ### is_catchall
172+
173+ Whether the email address is a catch-all address.
174+
175+ Return values: True, False, Unknown, -  ;  ;  ; (- means not applicable)
176+
177+ ### mailboxvalidator_score
178+
179+ Email address reputation score.
180+
181+ Score > 0.70 means good; score > 0.40 means fair; score <= 0.40 means poor.
182+
183+ ### time_taken
184+
185+ The time taken to get the results in seconds.
186+
187+ ### status
188+
189+ Whether our system think the email address is valid based on all the previous fields.
190+
191+ Return values: True, False
192+
193+ ### credits_available
194+
195+ The number of credits left to perform validations.
196+
197+ ### error_code
198+
199+ The error code if there is any error. See error table below.
200+
201+ ### error_message
202+
203+ The error message if there is any error. See error table below.
204+
205+ Errors
206+ ======
207+
208+ | error_code | error_message |
209+ | ---------- | ------------- |
210+ | 100 | Missing parameter. |
211+ | 101 | API key not found. |
212+ | 102 | API key disabled. |
213+ | 103 | API key expired. |
214+ | 104 | Insufficient credits. |
215+ | 105 | Unknown error. |
216+
83217Copyright
84218=========
85219
0 commit comments