puppeteer-email-session

Holds state for an authenticated puppeteer email session.

Install

npm install --save puppeteer-email-session

API

Table of Contents

• PuppeteerEmailSession
  • username
  • email
  • provider
  • browser
  • isAuthenticated
  • signout
  • sendEmail
  • getEmails
  • close

PuppeteerEmailSession

Holds state for an authenticated puppeteer email session.

Type: function (opts)

• opts object Options
  • opts.user object Authenticated user
    • opts.user.username string Authenticated user's username
    • opts.user.email string Authenticated user's email
  • opts.browser object Puppeteer Browser to use
  • opts.provider PuppeteerEmailProvider Email provider to use

---

username

Authenticated user's username.

Type: string

---

email

Authenticated user's email.

Type: string

---

provider

Email provider to use.

Type: PuppeteerEmailProvider

---

browser

Puppeteer Browser to use.

Type: string

---

isAuthenticated

Whether or not this session is currently authenticated with the given email provider.

Type: boolean

---

signout

Signs out of this session.

Type: function (): Promise

---

sendEmail

Sends an email from this session.

Type: function (email, opts): Promise

• email object TODO
• opts object? Options

---

getEmails

Fetches emails from the inbox of this session's account.

Type: function (opts)

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

---

close

Closes the underlying Puppeteer Browser instance, effectively ending this session.

Type: function (): Promise

---

Related

• puppeteer-email - Email automation driven by headless chrome.

License

MIT © Travis Fischer