Skip to content

Commit 766b8da

Browse files
MailboxValidatorMailboxValidator
committed
Update README.md
1 parent d00e12e commit 766b8da

File tree

1 file changed

+2
-271
lines changed

1 file changed

+2
-271
lines changed

‎README.md‎

Lines changed: 2 additions & 271 deletions
Original file line numberDiff line numberDiff line change
@@ -9,277 +9,8 @@ This library can be used in many types of projects such as:
99
- cleaning your mailing list prior to an email marketing campaign
1010
- a form of fraud check
1111

12-
Compilation
13-
===========
14-
15-
Just open the solution file in Visual Studio 2022 or later and compile:
16-
17-
Dependencies
18-
============
19-
20-
An API key is required for this library to function.
21-
22-
Go to https://www.mailboxvalidator.com/plans#api to sign up for a FREE API plan and you'll be given an API key.
23-
24-
Usage for validating emails
25-
===========================
26-
27-
```vbnet
28-
Imports Newtonsoft.Json
29-
30-
Module Program
31-
Sub Main(args As String())
32-
Dim apikey = "PASTE_YOUR_API_KEY_HERE"
33-
Dim email = "example@example.com"
34-
Dim mbv As New MailboxValidator.SingleValidation(apikey)
35-
36-
Dim mytask = mbv.ValidateEmailAsync(email) ' async API Call
37-
Dim myobj = mytask.Result
38-
39-
Console.WriteLine(JsonConvert.SerializeObject(myobj, Formatting.Indented)) ' to pretty-print the JSON
40-
41-
Console.WriteLine("email_address:" & myobj("email_address").ToString)
42-
Console.WriteLine("domain:" & myobj("domain").ToString)
43-
Console.WriteLine("is_free:" & myobj("is_free").ToString)
44-
Console.WriteLine("is_syntax:" & myobj("is_syntax").ToString)
45-
Console.WriteLine("is_domain:" & myobj("is_domain").ToString)
46-
Console.WriteLine("is_smtp:" & myobj("is_smtp").ToString)
47-
Console.WriteLine("is_verified:" & myobj("is_verified").ToString)
48-
Console.WriteLine("is_server_down:" & myobj("is_server_down").ToString)
49-
Console.WriteLine("is_greylisted:" & myobj("is_greylisted").ToString)
50-
Console.WriteLine("is_disposable:" & myobj("is_disposable").ToString)
51-
Console.WriteLine("is_suppressed:" & myobj("is_suppressed").ToString)
52-
Console.WriteLine("is_role:" & myobj("is_role").ToString)
53-
Console.WriteLine("is_high_risk:" & myobj("is_high_risk").ToString)
54-
Console.WriteLine("is_catchall:" & myobj("is_catchall").ToString)
55-
Console.WriteLine("mailboxvalidator_score:" & myobj("mailboxvalidator_score").ToString)
56-
Console.WriteLine("time_taken:" & myobj("time_taken").ToString)
57-
Console.WriteLine("status:" & myobj("status").ToString)
58-
Console.WriteLine("credits_available:" & myobj("credits_available").ToString)
59-
End Sub
60-
End Module
61-
```
62-
63-
Functions
64-
=========
65-
66-
### SingleValidation(api_key)
67-
68-
Creates a new instance of the MailboxValidator object with the API key.
69-
70-
### ValidateEmailAsync(email_address)
71-
72-
Performs email validation on the supplied email address.
73-
74-
Result Fields
75-
=============
76-
77-
### email_address
78-
79-
The input email address.
80-
81-
### domain
82-
83-
The domain of the email address.
84-
85-
### is_free
86-
87-
Whether the email address is from a free email provider like Gmail or Hotmail.
88-
89-
Return values: True, False
90-
91-
### is_syntax
92-
93-
Whether the email address is syntactically correct.
94-
95-
Return values: True, False
96-
97-
### is_domain
98-
99-
Whether the email address has a valid MX record in its DNS entries.
100-
101-
Return values: True, False, -   (- means not applicable)
102-
103-
### is_smtp
104-
105-
Whether the mail servers specified in the MX records are responding to connections.
106-
107-
Return values: True, False, -   (- means not applicable)
108-
109-
### is_verified
110-
111-
Whether the mail server confirms that the email address actually exist.
112-
113-
Return values: True, False, -   (- means not applicable)
114-
115-
### is_server_down
116-
117-
Whether the mail server is currently down or unresponsive.
118-
119-
Return values: True, False, -   (- means not applicable)
120-
121-
### is_greylisted
122-
123-
Whether the mail server employs greylisting where an email has to be sent a second time at a later time.
124-
125-
Return values: True, False, -   (- means not applicable)
126-
127-
### is_disposable
128-
129-
Whether the email address is a temporary one from a disposable email provider.
130-
131-
Return values: True, False, -   (- means not applicable)
132-
133-
### is_suppressed
134-
135-
Whether the email address is in our blacklist.
136-
137-
Return values: True, False, -   (- means not applicable)
138-
139-
### is_role
140-
141-
Whether the email address is a role-based email address like admin@example.net or webmaster@example.net.
142-
143-
Return values: True, False, -   (- means not applicable)
144-
145-
### is_high_risk
146-
147-
Whether the email address contains high risk keywords.
148-
149-
Return values: True, False, -   (- means not applicable)
150-
151-
### is_catchall
152-
153-
Whether the email address is a catch-all address.
154-
155-
Return values: True, False, Unknown, -   (- means not applicable)
156-
157-
### mailboxvalidator_score
158-
159-
Email address reputation score.
160-
161-
Score > 0.70 means good; score > 0.40 means fair; score <= 0.40 means poor.
162-
163-
### time_taken
164-
165-
The time taken to get the results in seconds.
166-
167-
### status
168-
169-
Whether our system think the email address is valid based on all the previous fields.
170-
171-
Return values: True, False
172-
173-
### credits_available
174-
175-
The number of credits left to perform validations.
176-
177-
178-
Usage for checking if an email is from a disposable email provider
179-
==================================================================
180-
181-
```vbnet
182-
Imports Newtonsoft.Json
183-
184-
Module Program
185-
Sub Main(args As String())
186-
Dim apikey = "PASTE_YOUR_API_KEY_HERE"
187-
Dim email = "example@example.com"
188-
Dim mbv As New MailboxValidator.SingleValidation(apikey)
189-
190-
Dim mytask = mbv.DisposableEmailAsync(email) ' async API Call
191-
Dim myobj = mytask.Result
192-
193-
Console.WriteLine(JsonConvert.SerializeObject(myobj, Formatting.Indented)) ' to pretty-print the JSON
194-
195-
Console.WriteLine("email_address:" & myobj("email_address").ToString)
196-
Console.WriteLine("is_disposable:" & myobj("is_disposable").ToString)
197-
Console.WriteLine("credits_available:" & myobj("credits_available").ToString)
198-
End Sub
199-
End Module
200-
```
201-
202-
Functions
203-
=========
204-
205-
### SingleValidation(api_key)
206-
207-
Creates a new instance of the MailboxValidator object with the API key.
208-
209-
### DisposableEmailAsync(email_address)
210-
211-
Check if the supplied email address is from a disposable email provider.
212-
213-
Result Fields
214-
=============
215-
216-
### email_address
217-
218-
The input email address.
219-
220-
### is_disposable
221-
222-
Whether the email address is a temporary one from a disposable email provider.
223-
224-
Return values: True, False
225-
226-
### credits_available
227-
228-
The number of credits left to perform validations.
229-
230-
231-
Usage for checking if an email is from a free email provider
232-
============================================================
233-
234-
```vbnet
235-
Imports Newtonsoft.Json
236-
237-
Module Program
238-
Sub Main(args As String())
239-
Dim apikey = "PASTE_YOUR_API_KEY_HERE"
240-
Dim email = "example@example.com"
241-
Dim mbv As New MailboxValidator.SingleValidation(apikey)
242-
243-
Dim mytask = mbv.FreeEmailAsync(email) ' async API Call
244-
Dim myobj = mytask.Result
245-
246-
Console.WriteLine(JsonConvert.SerializeObject(myobj, Formatting.Indented)) ' to pretty-print the JSON
247-
248-
Console.WriteLine("email_address:" & myobj("email_address").ToString)
249-
Console.WriteLine("is_free:" & myobj("is_free").ToString)
250-
Console.WriteLine("credits_available:" & myobj("credits_available").ToString)
251-
End Sub
252-
End Module
253-
```
254-
255-
Functions
256-
=========
257-
258-
### SingleValidation(api_key)
259-
260-
Creates a new instance of the MailboxValidator object with the API key.
261-
262-
### FreeEmailAsync(email_address)
263-
264-
Check if the supplied email address is from a free email provider.
265-
266-
Result Fields
267-
=============
268-
269-
### email_address
270-
271-
The input email address.
272-
273-
### is_free
274-
275-
Whether the email address is from a free email provider like Gmail or Hotmail.
276-
277-
Return values: True, False
278-
279-
### credits_available
280-
281-
The number of credits left to perform validations.
282-
12+
# Developer Documentation
13+
To learn more about installation, usage, and code examples, please visit the developer documentation at [https://mailboxvalidator-vbnet.readthedocs.io/en/latest/index.html.](https://mailboxvalidator-vbnet.readthedocs.io/en/latest/index.html)
28314

28415
Copyright
28516
=========

0 commit comments

Comments
 (0)