npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

getinbox

v1.0.0

Published

Find and verify email addresses

Downloads

94

Readme

getinbox-js

getinbox is maintained by Getinbox - simple, fast and free online email finder tools.


Email finder & verifier for Node.js

  • Find anyone's professional email address with 99% accuracy
  • Verify email deliverability without sending test emails
  • Detect disposable email addresses
  • Double-verifies catch-all mailboxes
  • Full TypeScript support with detailed type definitions

Installation

npm install getinbox

Quick Start

import { Getinbox } from 'getinbox';

// Initialize the client
const getinbox = new Getinbox({
  apiKey: 'your_api_key', // or set GETINBOX_API_KEY env variable
});

// Find an email address
const { email } = await getinbox.emails.find({
  name: 'Elon Musk',
  company: 'spacex.com', // Using domain instead of company name provides better accuracy
});

// Verify an email address
const { isValid } = await getinbox.emails.verify({
  email: '[email protected]',
});

Requirements

  • Node.js 14 or later
  • TypeScript 4.7 or later (optional)

API Reference

Authentication

Sign up for a free API key at 👉 getinbox.co/dashboard/api-key.

You can provide your API key in two ways:

1. Pass it when initializing the client:

const getinbox = new Getinbox({ apiKey: 'your_api_key' });

2. Set it as an environment variable:

export GETINBOX_API_KEY=your_api_key
const getinbox = new Getinbox(); // Will use GETINBOX_API_KEY env variable

Finding Email Addresses

Find someone's email address using their name and company information:

const response = await getinbox.emails.find({
  name: 'John Doe', // Full name of the person
  company: 'acme.com', // Company domain (preferred) or name
});

console.log(response.email); // => '[email protected]'

Verifying Email Addresses

Verify if an email address exists and is deliverable:

const response = await getinbox.emails.verify({
  email: '[email protected]',
});

console.log(response.isValid); // => true/false

Features in Detail

Email Finder

  • Discovers professional email addresses with 99% accuracy
  • Uses advanced pattern matching and verification
  • Cleans and formats input data automatically
  • Real-time verification of found emails

Email Verifier

  • Validates email existence without sending test emails
  • Checks syntax, domain validity, and mailbox existence
  • Detects disposable email addresses
  • Identifies catch-all domains
  • Helps maintain sender reputation by preventing bounces

Error Handling

The SDK throws descriptive errors for invalid API keys, failed requests, and API errors:

try {
  const response = await getinbox.emails.find({
    name: 'John Doe',
    company: 'acme.com',
  });
} catch (error) {
  console.error('Error finding email:', error.message);
}

TypeScript Support

The SDK is written in TypeScript and provides comprehensive type definitions:

import {
  GetinboxOptions,
  FindEmailOptions,
  VerifyEmailOptions,
} from 'getinbox';

// All options are fully typed
const options: FindEmailOptions = {
  name: 'John Doe',
  company: 'acme.com',
};

Types

GetinboxOptions

| Property | Type | Description | Required | | -------- | -------- | --------------------- | ---------------------------- | | apiKey | string | Your Getinbox API key | false (if set via env var) |

FindEmailOptions

| Property | Type | Description | Required | | --------- | -------- | ----------------------- | -------- | | name | string | Full name of the person | true | | company | string | Company domain or name | true |

VerifyEmailOptions

| Property | Type | Description | Required | | -------- | -------- | ----------------------- | -------- | | email | string | Email address to verify | true |

License

Distributed under the MIT License. See LICENSE for more information.

Links

If you need support please contact us at 👉 [email protected]