Skip to content

Latest commit

 

History

History
130 lines (79 loc) · 6.08 KB

readme.md

File metadata and controls

130 lines (79 loc) · 6.08 KB
Raw

puppeteer-email-provider

Abstract base class for puppeteer email providers.

NPM Build Status JavaScript Style Guide

Install

npm install --save puppeteer-email-provider

Usage

TODO

API

Table of Contents

PuppeteerEmailProvider

Abstract base class for pupeteer email providers.

Type: function ()

name

Provider name.

Type: string

signup

Creates a new email account using this provider.

Some providers may require additional user information during signup.

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
    • opts.browser Object Puppeteer browser instance to use

signin

Signs into an existing email account using this 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)
  • opts object Options
    • opts.browser Object Puppeteer browser instance to use

signout

Signs out of the given authenticated session using this provider.

Type: function (session): Promise

  • session PuppeteerEmailSession

sendEmail

Sends an email from an authenticated session using this provider.

Type: function (session, email, opts): Promise

  • session PuppeteerEmailSession
  • email object Details of email to send
  • opts object? Options

getEmails

Fetches emails visible from the inbox of an authenticated session using this provider.

Type: function (session, opts)

  • session PuppeteerEmailSession
  • opts object? Options
    • opts.query string? Search query to narrow down results

Related

License

MIT © Travis Fischer