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
This Python module provides an easy way to call the MailboxValidator API which validates if an email address is a valid one.
4
+
This Python module enables user to easily validate if an email address is valid, a type of disposable email or free email.
5
+
6
+
This module can be useful in many types of projects, for example
7
+
8
+
- to validate an user's email during sign up
9
+
- to clean your mailing list prior to email sending
10
+
- to perform fraud check
11
+
- and so on
5
12
6
-
This module can be used in many types of projects such as:
7
13
8
-
- validating a user's email during sign up
9
-
- cleaning your mailing list prior to an email marketing campaign
10
-
- a form of fraud check
11
-
12
-
13
14
Installation
14
15
============
15
16
@@ -26,8 +27,75 @@ An API key is required for this module to function.
26
27
Go to https://www.mailboxvalidator.com/plans#api to sign up for FREE API plan and you'll be given an API key.
27
28
28
29
29
-
Usage for validating emails
30
-
===========================
30
+
Functions
31
+
=========
32
+
33
+
## SingleValidation(api_key)
34
+
35
+
Creates a new instance of the MailboxValidator object with the API key.
36
+
37
+
## ValidateEmail(email_address)
38
+
39
+
Performs email validation on the supplied email address.
40
+
41
+
### Return Fields
42
+
43
+
| Field Name | Description |
44
+
|-----------|------------|
45
+
| email_address | The input email address. |
46
+
| domain | The domain of the email address. |
47
+
| is_free | Whether the email address is from a free email provider like Gmail or Hotmail. Return values: True, False |
48
+
| is_syntax | Whether the email address is syntactically correct. Return values: True, False |
49
+
| is_domain | Whether the email address has a valid MX record in its DNS entries. Return values: True, False, - (- means not applicable) |
50
+
| is_smtp | Whether the mail servers specified in the MX records are responding to connections. Return values: True, False, - (- means not applicable) |
51
+
| is_verified | Whether the mail server confirms that the email address actually exist. Return values: True, False, - (- means not applicable) |
52
+
| is_server_down | Whether the mail server is currently down or unresponsive. Return values: True, False, - (- means not applicable) |
53
+
| 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) |
54
+
| is_disposable | Whether the email address is a temporary one from a disposable email provider. Return values: True, False, - (- means not applicable) |
55
+
| is_suppressed | Whether the email address is in our blacklist. Return values: True, False, - (- means not applicable) |
56
+
| 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) |
57
+
| is_high_risk | Whether the email address contains high risk keywords. Return values: True, False, - (- means not applicable) |
58
+
| is_catchall | Whether the email address is a catch-all address. Return values: True, False, Unknown, - (- means not applicable) |
59
+
| mailboxvalidator_score | Email address reputation score. Score > 0.70 means good; score > 0.40 means fair; score <= 0.40 means poor. |
60
+
| time_taken | The time taken to get the results in seconds. |
61
+
| status | Whether our system think the email address is valid based on all the previous fields. Return values: True, False |
62
+
| credits_available | The number of credits left to perform validations. |
63
+
| error_code | The error code if there is any error. See error table in the below section. |
64
+
| error_message | The error message if there is any error. See error table in the below section. |
65
+
66
+
## DisposableEmail(email_address)
67
+
68
+
Check if the supplied email address is from a disposable email provider.
69
+
70
+
### Return Fields
71
+
72
+
| Field Name | Description |
73
+
|-----------|------------|
74
+
| email_address | The input email address. |
75
+
| is_disposable | Whether the email address is a temporary one from a disposable email provider. Return values: True, False |
76
+
| credits_available | The number of credits left to perform validations. |
77
+
| error_code | The error code if there is any error. See error table in the below section. |
78
+
| error_message | The error message if there is any error. See error table in the below section. |
79
+
80
+
## FreeEmail(email_address)
81
+
82
+
Check if the supplied email address is from a free email provider.
83
+
84
+
### Return Fields
85
+
86
+
| Field Name | Description |
87
+
|-----------|------------|
88
+
| email_address | The input email address. |
89
+
| is_free | Whether the email address is from a free email provider like Gmail or Hotmail. Return values: True, False |
90
+
| credits_available | The number of credits left to perform validations. |
91
+
| error_code | The error code if there is any error. See error table in the below section. |
92
+
| error_message | The error message if there is any error. See error table below. |
0 commit comments