zerobounce-node-api

2.0.0 • Public • Published

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
Property Possible Values
address The email address you are validating.
status valid /invalid /catch-all /unknown /spamtrap /abuse /do_not_mail
sub_status antispam_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
account The portion of the email address before the "@" symbol.
domain The portion of the email address after the "@" symbol.
did_you_mean Suggestive Fix for an email typo.
domain_age_days Age of the email domain in days or [null].
free_email [true/false] If the email comes from a free provider.
mx_found [true/false] Does the domain have an MX record.
mx_record The preferred MX record of the domain
smtp_provider The SMTP Provider of the email or null.
firstname The first name of the owner of the email when available or [null].
lastname The last name of the owner of the email when available or [null].
gender The gender of the owner of the email when available or [null].
country The country the email signed up when ip address is provided or [null].
region The region the email signed up when ip address is provided or [null].
city The city the email signed up when ip address is provided or [null].
zipcode The zipcode the email signed up when ip address is provided or [null].
processed_at The UTC time the email was validated.
  1. getCredit method
Property Possible Values
credits The 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:

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

  • 99.110.204.1

Package Sidebar

Install

npm i zerobounce-node-api

Weekly Downloads

1,001

Version

2.0.0

License

ISC

Unpacked Size

8.05 kB

Total Files

5

Last publish

Collaborators

  • potatomasterrace