# puppeteer-email-session > Holds state for an authenticated puppeteer email session. Latest version **0.0.5** (published 2018-05-21) · MIT license · 0 weekly downloads ## Install ```sh npm install puppeteer-email-session pnpm add puppeteer-email-session yarn add puppeteer-email-session bun add puppeteer-email-session ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.5 | | Published | 2018-05-21 | | First published | 2018-05-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=8 | | Dependencies | 2 | | Unpacked size | 8.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 167 | | Author | Travis Fischer | | Maintainers | fisch0920 | | Keywords | puppeteer, email | ## Links - npm: https://www.npmjs.com/package/puppeteer-email-session - Repository: https://github.com/transitive-bullshit/puppeteer-email - npm.io page: https://npm.io/package/puppeteer-email-session ## Dependencies (2) - [ow](https://npm.io/package/ow.md) ^0.3.0 - [puppeteer-email-provider](https://npm.io/package/puppeteer-email-provider.md) ^0.0.5 ## Alternatives - [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads - [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads - [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads - [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads - [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads ## Recent versions - 0.0.5 (latest) — 2018-05-21 - 0.0.4 — 2018-05-15 - 0.0.3 — 2018-05-14 - 0.0.2 — 2018-05-09 - 0.0.1 — 2018-05-09 ## README # puppeteer-email-session > Holds state for an authenticated puppeteer email session. [![NPM](https://img.shields.io/npm/v/puppeteer-email-session.svg)](https://www.npmjs.com/package/puppeteer-email-session) [![Build Status](https://travis-ci.com/transitive-bullshit/puppeteer-email.svg?branch=master)](https://travis-ci.com/transitive-bullshit/puppeteer-email) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) ## Install ```bash npm install --save puppeteer-email-session ``` ## API #### Table of Contents - [PuppeteerEmailSession](#puppeteeremailsession) - [username](#username) - [email](#email) - [provider](#provider) - [browser](#browser) - [isAuthenticated](#isauthenticated) - [signout](#signout) - [sendEmail](#sendemail) - [getEmails](#getemails) - [close](#close) ### [PuppeteerEmailSession](https://github.com/transitive-bullshit/puppeteer-email/blob/d2ce2dbdb8ee7041c8fd447f3d23f302acf28966/packages/puppeteer-email-session/index.js#L16-L120) Holds state for an authenticated puppeteer email session. Type: `function (opts)` - `opts` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options - `opts.user` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Authenticated user - `opts.user.username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Authenticated user's username - `opts.user.email` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Authenticated user's email - `opts.browser` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Puppeteer Browser to use - `opts.provider` **PuppeteerEmailProvider** Email provider to use * * * #### [username](https://github.com/transitive-bullshit/puppeteer-email/blob/d2ce2dbdb8ee7041c8fd447f3d23f302acf28966/packages/puppeteer-email-session/index.js#L34-L34) Authenticated user's username. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) * * * #### [email](https://github.com/transitive-bullshit/puppeteer-email/blob/d2ce2dbdb8ee7041c8fd447f3d23f302acf28966/packages/puppeteer-email-session/index.js#L41-L41) Authenticated user's email. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) * * * #### [provider](https://github.com/transitive-bullshit/puppeteer-email/blob/d2ce2dbdb8ee7041c8fd447f3d23f302acf28966/packages/puppeteer-email-session/index.js#L48-L48) Email provider to use. Type: PuppeteerEmailProvider * * * #### [browser](https://github.com/transitive-bullshit/puppeteer-email/blob/d2ce2dbdb8ee7041c8fd447f3d23f302acf28966/packages/puppeteer-email-session/index.js#L55-L55) Puppeteer Browser to use. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) * * * #### [isAuthenticated](https://github.com/transitive-bullshit/puppeteer-email/blob/d2ce2dbdb8ee7041c8fd447f3d23f302acf28966/packages/puppeteer-email-session/index.js#L63-L63) Whether or not this session is currently authenticated with the given email provider. Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) * * * #### [signout](https://github.com/transitive-bullshit/puppeteer-email/blob/d2ce2dbdb8ee7041c8fd447f3d23f302acf28966/packages/puppeteer-email-session/index.js#L70-L77) Signs out of this session. Type: `function (): Promise` * * * #### [sendEmail](https://github.com/transitive-bullshit/puppeteer-email/blob/d2ce2dbdb8ee7041c8fd447f3d23f302acf28966/packages/puppeteer-email-session/index.js#L87-L93) Sends an email from this session. Type: `function (email, opts): Promise` - `email` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** TODO - `opts` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options * * * #### [getEmails](https://github.com/transitive-bullshit/puppeteer-email/blob/d2ce2dbdb8ee7041c8fd447f3d23f302acf28966/packages/puppeteer-email-session/index.js#L103-L109) Fetches emails from the inbox of this session's account. Type: `function (opts)` - `opts` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options - `opts.query` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Search query to narrow down results * * * #### [close](https://github.com/transitive-bullshit/puppeteer-email/blob/d2ce2dbdb8ee7041c8fd447f3d23f302acf28966/packages/puppeteer-email-session/index.js#L117-L119) Closes the underlying Puppeteer Browser instance, effectively ending this session. Type: `function (): Promise` * * * ## Related - [puppeteer-email](https://github.com/transitive-bullshit/puppeteer-email) - Email automation driven by headless chrome. ## License MIT © [Travis Fischer](https://github.com/transitive-bullshit) --- _Source: https://npm.io/package/puppeteer-email-session · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._