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 🙏

© 2026 – Pkg Stats / Ryan Hefner

puppeteer-email

v0.1.0

Published

Email automation driven by headless chrome.

Readme

puppeteer-email

Email automation drive by headless chrome.

NPM Build Status JavaScript Style Guide

Install

npm install --save puppeteer-email

Usage

This example signs into an Outlook account, searches for a given query, and then parses and returns all emails returned for that query.

const PuppeteerEmail = require('puppeteer-email')

const client = new PuppeteerEmail('outlook')

const username = 'xxx'
const password = 'xxx'

const session = await client.signin({ username, password })
const emails = await session.getEmails({ query: 'from:github' })
await session.close()
console.log(emails)

Example parsed email output:

[
  {
    "attachments": [ /* ... */ ],
    "headers": { /* ... */ },
    "html": "<!DOCTYPE html>\n<html>...</html>",
    "text": "...",
    "textAsHtml": "<p>...</p>",
    "subject": "Example email subject",
    "date": "2018-05-09T14:17:02.000Z",
    "to": {
      "value": [
        {
          "address": "[email protected]",
          "name": "Travis Fischer"
        }
      ],
      "html": "<span class=\"mp_address_name\">Travis Fischer</span> &lt;<a href=\"mailto:[email protected]\" class=\"mp_address_email\">[email protected]</a>&gt;",
      "text": "Travis Fischer <[email protected]>"
    },
    "from": {
      "value": [
        {
          "address": "[email protected]",
          "name": "GitHub"
        }
      ],
      "html": "<span class=\"mp_address_name\">GitHub</span> &lt;<a href=\"mailto:[email protected]\" class=\"mp_address_email\">[email protected]</a>&gt;",
      "text": "GitHub <[email protected]>"
    },
    "messageId": "<01.B3.11399.xxxxxxxx@momentum1-mta1>"
  }
]

See parse-email for details on email model properties.

API

Table of Contents

PuppeteerEmail

Main entrypoint for authenticating and automating a given email provider.

Type: function (provider)

  • provider (string | PuppeteerEmailProvider) Name of built-in email provider or an email address belonging to a built-in email provider. May also be an instance of a custom PuppeteerEmailProvider.

Examples:

const client = new PuppeteerEmail('outlook')
const session = await client.signin({ username: 'xxx', password: 'xxx' })
const emails = await session.getEmails({ query: 'from:amazon' })
await session.close()
const client = new PuppeteerEmail('[email protected]')
const session = await client.signin({ email: '[email protected]', password: 'xxx' })
await session.close()

provider

Email provider to automate.

Type: PuppeteerEmailProvider


signup

Creates a new email account using the set email provider.

Any user information that isn't provided will be filled in using faker.js.

Returns an email session with the authenticated puppeteer browser.

Type: function (user, opts)

  • user object? User info for the account to create
    • user.username string? Username
    • user.password string? Password
    • user.firstName string? User's given name
    • user.lastName string? User's family name
    • user.birthday object? User's birthday
      • user.birthday.month string? User's birthday month
      • user.birthday.day string? User's birthday day
      • user.birthday.year string? User's birthday year
  • opts object? Options (optional, default {})

signin

Signs into an existing email account using the set email provider.

You must specify either user.username or user.email.

Returns an email session with the authenticated puppeteer browser.

Type: function (user, opts)

  • user object User info for the account to sign into
    • user.username string? Username (implies email)
    • user.email string? Email (implies username)
    • user.password string Password
  • opts object? Options (optional, default {})

Related

Disclaimer

Using this software to violate the terms and conditions of any third-party service is strictly against the intent of this software. By using this software, you are acknowledging this fact and absolving the author or any potential liability or wrongdoing it may cause. This software is meant for testing and experimental purposes only, so please act responsibly.

License

MIT © Travis Fischer