Email Batch Cleansing
Data must be provided in a csv file, containing the following columns.
Column | Type | Required | Description |
---|---|---|---|
id | string | A unique identifier for the row | |
email_address | string | ✔️ | The email address to be cleansed |
It is possible to perform more than one type of cleanse on a single CSV file. For example, an email cleanse could be run on a file, followed by an address cleanse. Make sure that all the required columns are included for each cleanse you wish to perform. The columns can be included in any order. Fields can be left blank if the column is not applicable.
Cleansed File
The returned file will contain the provided columns, and the following:
email_match_status
email_error_codes
cleansed_email_address
The email_match_status
column will contain the status of the cleanse.
Status | Description |
---|---|
full_match | The email address was found and is a perfect match |
partial_match | The email address was found but may not be valid e.g. disposable |
no_match | The provided email address is not valid |
error | There was an error with the email cleanse |
The email_error_codes
column will contain a comma separated list of reasons why the cleanse wasn't a full match
email_address
Error | Description |
---|---|
catch_all | The provider accepts any email even if the mailbox is invalid |
high_risk_domain | The email address belongs to a high risk domain |
immature_domain | The email address belongs to a newly created domain |
is_disposable_address | The provided email address is disposable |
long_term_disposable | The provided email address is a long term disposable email |
subdomain_mailer | The email address belongs to a subdomain |
tld_risk | There is a risk with the top level domain of the email address |
failed_custom_grammar_check | The custom grammar check for this provider failed |
failed_grammar_check | The grammar check failed |
mailbox_does_not_exist | The mailbox does not exist for this domain |
no_mx_records_for_domain | No mx records for the domain were found |
domain_name_invalid | The domain name of the email address does not exist |
email_invalid | The provided email address is not valid |
error
Error | Description |
---|---|
dns_server_failure | There was a dns server failure during the cleanse |
provider_communication_error | There was a communication error with the provider of the email address |
smtp_error | There was an error with the smtp |
smtp_timeout | The smtp resulted in a timeout |
unknown_server_error | There was an unknown server error |