Skip to content

Latest commit

 

History

History

puppeteer-email

Folders and files

NameName
Last commit message
Last commit date

parent directory

..

lib

lib

 
 

index.js

index.js

 
 

package.json

package.json

 
 

readme.md

readme.md

 
 

yarn.lock

yarn.lock

 
 

readme.md

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": "fischxxxx@outlook.com",
          "name": "Travis Fischer"
        }
      ],
      "html": "<span class=\"mp_address_name\">Travis Fischer</span> &lt;<a href=\"mailto:fischxxxx@outlook.com\" class=\"mp_address_email\">fischxxxx@outlook.com</a>&gt;",
      "text": "Travis Fischer <fischxxxx@outlook.com>"
    },
    "from": {
      "value": [
        {
          "address": "noreply@github.com",
          "name": "GitHub"
        }
      ],
      "html": "<span class=\"mp_address_name\">GitHub</span> &lt;<a href=\"mailto:noreply@github.com\" class=\"mp_address_email\">noreply@github.com</a>&gt;",
      "text": "GitHub <noreply@github.com>"
    },
    "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('test@outlook.com')
const session = await client.signin({ email: 'test@outlook.com', 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