# puppeteer-email-provider-outlook

> Puppeteer email provider for Outlook.

Latest version **0.1.0** (published 2018-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install puppeteer-email-provider-outlook
pnpm add puppeteer-email-provider-outlook
yarn add puppeteer-email-provider-outlook
bun add puppeteer-email-provider-outlook
```

## 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.1.0 |
| Published | 2018-07-17 |
| First published | 2018-05-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 8 |
| Unpacked size | 25.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 166 |
| Author | Travis Fischer |
| Maintainers | fisch0920 |
| Keywords | puppeteer, email, outlook, microsoft |

## Links

- npm: https://www.npmjs.com/package/puppeteer-email-provider-outlook
- Repository: https://github.com/transitive-bullshit/puppeteer-email
- npm.io page: https://npm.io/package/puppeteer-email-provider-outlook

## Dependencies (8)

- [ow](https://npm.io/package/ow.md) ^0.6.0
- [delay](https://npm.io/package/delay.md) ^2.0.0
- [faker](https://npm.io/package/faker.md) ^4.1.0
- [p-map](https://npm.io/package/p-map.md) ^1.2.0
- [tempy](https://npm.io/package/tempy.md) ^0.2.1
- [parse-email](https://npm.io/package/parse-email.md) ^1.0.0
- [puppeteer-email-session](https://npm.io/package/puppeteer-email-session.md) ^0.0.5
- [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.1.0 (latest) — 2018-07-17
- 0.0.7 — 2018-05-21
- 0.0.6 — 2018-05-15
- 0.0.5 — 2018-05-14
- 0.0.4 — 2018-05-10
- 0.0.3 — 2018-05-10
- 0.0.2 — 2018-05-09
- 0.0.1 — 2018-05-09

## README

# puppeteer-email-provider-outlook

> Puppeteer email provider for [Outlook](https://outlook.live.com).

[![NPM](https://img.shields.io/npm/v/puppeteer-email-provider-outlook.svg)](https://www.npmjs.com/package/puppeteer-email-provider-outlook) [![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-provider-outlook
```

## API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

#### Table of Contents

-   [PuppeteerEmailProviderOutlook](#puppeteeremailprovideroutlook)
    -   [name](#name)
    -   [signup](#signup)
    -   [signin](#signin)
    -   [signout](#signout)
    -   [sendEmail](#sendemail)
    -   [getEmails](#getemails)

### [PuppeteerEmailProviderOutlook](https://github.com/transitive-bullshit/puppeteer-email/blob/a5e0c04002d628c370d4ed7dad0e5550c749ab3b/packages/puppeteer-email-provider-outlook/index.js#L19-L167)

**Extends: PuppeteerEmailProvider**

Puppeteer email provider for [Outlook](https://outlook.live.com).

Type: `function ()`

* * *

#### [name](https://github.com/transitive-bullshit/puppeteer-email/blob/a5e0c04002d628c370d4ed7dad0e5550c749ab3b/packages/puppeteer-email-provider-outlook/index.js#L25-L27)

Email provider to automate.

Type: PuppeteerEmailProvider

* * *

#### [signup](https://github.com/transitive-bullshit/puppeteer-email/blob/a5e0c04002d628c370d4ed7dad0e5550c749ab3b/packages/puppeteer-email-provider-outlook/index.js#L49-L66)

Creates a new email account.

Returns an email session with the authenticated puppeteer browser.

Type: `function (user, opts)`

-   `user` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** User info for the account to create
    -   `user.username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Username
    -   `user.password` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Password
    -   `user.firstName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** User's given name
    -   `user.lastName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** User's family name
    -   `user.birthday` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** User's birthday
        -   `user.birthday.month` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** User's birthday month
        -   `user.birthday.day` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** User's birthday day
        -   `user.birthday.year` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** User's birthday year
-   `opts` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options
    -   `opts.browser` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Puppeteer browser instance to use

* * *

#### [signin](https://github.com/transitive-bullshit/puppeteer-email/blob/a5e0c04002d628c370d4ed7dad0e5550c749ab3b/packages/puppeteer-email-provider-outlook/index.js#L85-L112)

Signs into an existing email account.

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

Returns an email session with the authenticated puppeteer browser.

Type: `function (user, opts)`

-   `user` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** User info for the account to sign into
    -   `user.username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Username (implies email)
    -   `user.email` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Email (implies username)
    -   `user.password` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Password
-   `opts` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options
    -   `opts.browser` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Puppeteer browser instance to use

* * *

#### [signout](https://github.com/transitive-bullshit/puppeteer-email/blob/a5e0c04002d628c370d4ed7dad0e5550c749ab3b/packages/puppeteer-email-provider-outlook/index.js#L121-L127)

Signs out of an authenticated session.

Type: `function (session): Promise`

-   `session` **PuppeteerEmailSession** 

* * *

#### [sendEmail](https://github.com/transitive-bullshit/puppeteer-email/blob/a5e0c04002d628c370d4ed7dad0e5550c749ab3b/packages/puppeteer-email-provider-outlook/index.js#L138-L147)

Sends an email from an authenticated session.

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

-   `session` **PuppeteerEmailSession** 
-   `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 (optional, default `{}`)

* * *

#### [getEmails](https://github.com/transitive-bullshit/puppeteer-email/blob/a5e0c04002d628c370d4ed7dad0e5550c749ab3b/packages/puppeteer-email-provider-outlook/index.js#L158-L166)

Fetches emails from the inbox of an authenticated session.

Type: `function (session, opts)`

-   `session` **PuppeteerEmailSession** 
-   `opts` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options (optional, default `{}`)
    -   `opts.query` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Search query to narrow down results

* * *

## 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-provider-outlook · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
