Email metadata

The email verification service returns useful information about each email address. This information may be 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	email	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 and accepts mail sent to any address at that domain. `false` means the domain only accepts mail addressed to a specific mailbox, and `null` means the status could not be determined
`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
`deliverability`	String	`DELIVERABLE`	A graded confidence level for whether mail sent to this address will arrive, where `is_verified` is a single boolean. One of: `DELIVERABLE`: the mailbox exists and can receive mail. `LIKELY_DELIVERABLE`: probably deliverable, for example the domain accepts all addresses (catch-all) so the individual mailbox cannot be confirmed. `UNLIKELY_DELIVERABLE`: probably not deliverable, for example the mailbox is full. `UNDELIVERABLE`: the address cannot receive mail, because of an invalid format, a domain that cannot receive email, or a mailbox that does not exist. `UNDETERMINED`: we could not reach a conclusion, for example the mail provider temporarily blocked or rate-limited our check. Safe to retry later, and does not consume a verification lookup.

*The success response only indicates if the verification process ran successfully regardless of if the email address is valid or not.

For email verification lite (check: "format"), the is_disposable, is_role, is_public and is_catch_all attributes are returned as null, and deliverability is returned as UNDETERMINED, because none of these are evaluated. Additionally, is_verified reflects syntax validity only and does not indicate deliverability.

The widget's built-in rules do not act on deliverability — only is_verified and your configured rules drive the tick/warn/block behaviour. To react to deliverability yourself, read it from the metadata object in your own result:verified/result:not_verified handler.

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.