Email metadata
The email verification service returns useful information about each email address. This information maybe captured and used for important downstream purposes.
Metadata returned
Name | Type | Example | Description |
---|---|---|---|
success | Boolean | true | Returns true if the service ran successfully* |
verified_email | String | email@example.com | The full verified email address |
email_account | String | The first part of the email address | |
email_domain | String | example.com | The second part of the email address |
is_verified | Boolean | true | The address is valid and verified |
is_disposable | Boolean | true | The address is disposable |
is_role | Boolean | true | The address is a group email (e.g. support@addressfinder.com) |
is_public | Boolean | true | The email provider is public (e.g. Gmail, Yahoo, etc.) |
is_catch_all | Boolean | true | The email domain has a catch-all policy |
not_verified_reason | String | The email format is incorrect | A short description of why is_verified is false |
not_verified_code | String | FORMAT_INVALID | Error code if is_verified is false |
email_provider_domain | String | google.com | The base domain of the email provider |
*The success
response only indicates if the verification process ran successfully regardless of if the email address is valid or not.
Collecting email metadata
The widget can be configured to collect the above metadata from the Email Verification API response.
View this code example demonstrating the EV widget's ability to collect and store the returned metadata. In this example, the widget is making use of the result:verified
and result:not_verified
events.
Review the constructor, methods, options and events documented in the Javascript Reference page.