Socket
Socket
Sign inDemoInstall

zerobounce-node-api

Package Overview
Dependencies
2
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    zerobounce-node-api

Forked zerobounce api for npm


Version published
Weekly downloads
826
decreased by-21.18%
Maintainers
1
Install size
5.73 MB
Created
Weekly downloads
 

Readme

Source

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_email[true/false] If the email comes from a free provider.
mx_found[true/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] (BETA).
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:

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

  • 99.110.204.1

Keywords

FAQs

Last updated on 23 Aug 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc