2.0.0 • Published 6 years ago

zerobounce-node-api v2.0.0

Weekly downloads
112
License
ISC
Repository
github
Last release
6 years ago

ZeroBounce API v2 (node version)

This is an unofficial port of zerobounce javascript api v2 to node

Usage :

Init :

const zeroBounceApi = require('../ZeroBounceApi');
const zb = zeroBounceApi('xxxxxxxxx'); // put your api key

Get Credits :

zb.getCredits()
  .then((credits)=> console.log(credits)); // credits is type number

Validate :

zb.getCredits()
  .validate((resp)=> console.log(resp)); // see resp values below

Properties and possible values returned by: 1. validate method

PropertyPossible Values
addressThe email address you are validating.
statusvalid /invalid /catch-all /unknown /spamtrap /abuse /do_not_mail
sub_statusantispam_system /greylisted /mail_server_temporary_error /forcible_disconnect /mail_server_did_not_respond /timeout_exceeded /failed_smtp_connection /mailbox_quota_exceeded /exception_occurred /possible_traps /role_based /global_suppression /mailbox_not_found /no_dns_entries /failed_syntax_check /possible_typo /unroutable_ip_address /leading_period_removed /does_not_accept_mail /role_based_catch_all /disposable /toxic
accountThe portion of the email address before the "@" symbol.
domainThe portion of the email address after the "@" symbol.
did_you_meanSuggestive Fix for an email typo.
domain_age_daysAge of the email domain in days or null.
free_emailtrue/false If the email comes from a free provider.
mx_foundtrue/false Does the domain have an MX record.
mx_recordThe preferred MX record of the domain
smtp_providerThe SMTP Provider of the email or null.
firstnameThe first name of the owner of the email when available or null.
lastnameThe last name of the owner of the email when available or null.
genderThe gender of the owner of the email when available or null.
countryThe country the email signed up when ip address is provided or null.
regionThe region the email signed up when ip address is provided or null.
cityThe city the email signed up when ip address is provided or null.
zipcodeThe zipcode the email signed up when ip address is provided or null.
processed_atThe UTC time the email was validated.
  1. getCredit method

PropertyPossible Values
creditsThe number of credits left in account for email validation.

Any of the following email addresses can be used for testing the API, no credits are charged for these test email addresses:

  • disposable@example.com
  • invalid@example.com
  • valid@example.com
  • toxic@example.com
  • donotmail@example.com
  • spamtrap@example.com
  • abuse@example.com
  • unknown@example.com
  • catch_all@example.com
  • antispam_system@example.com
  • does_not_accept_mail@example.com
  • exception_occurred@example.com
  • failed_smtp_connection@example.com
  • failed_syntax_check@example.com
  • forcible_disconnect@example.com
  • global_suppression@example.com
  • greylisted@example.com
  • leading_period_removed@example.com
  • mail_server_did_not_respond@example.com
  • mail_server_temporary_error@example.com
  • mailbox_quota_exceeded@example.com
  • mailbox_not_found@example.com
  • no_dns_entries@example.com
  • possible_trap@example.com
  • possible_typo@example.com
  • role_based@example.com
  • timeout_exceeded@example.com
  • unroutable_ip_address@example.com
  • free_email@example.com

You can use this IP to test the GEO Location in the API.

  • 99.110.204.1