Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/transitive-bullshit/puppeteer-email
Email automation driven by headless chrome.
https://github.com/transitive-bullshit/puppeteer-email
automation bots email email-automation headless-chrome puppeteer
Last synced: 8 days ago
JSON representation
Email automation driven by headless chrome.
- Host: GitHub
- URL: https://github.com/transitive-bullshit/puppeteer-email
- Owner: transitive-bullshit
- Created: 2018-05-09T19:46:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-05T05:23:46.000Z (almost 4 years ago)
- Last Synced: 2024-10-22T14:36:36.745Z (17 days ago)
- Topics: automation, bots, email, email-automation, headless-chrome, puppeteer
- Language: JavaScript
- Size: 275 KB
- Stars: 164
- Watchers: 9
- Forks: 22
- Open Issues: 9
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-puppeteer - puppeteer-email - Email automation driven by headless chrome. (Packages)
- awesome-puppeteer-zh - puppeteer-email - puppeteer 驱动的电子邮件自动化. (包 / 贡献)
- jimsghstars - transitive-bullshit/puppeteer-email - Email automation driven by headless chrome. (JavaScript)
README
# puppeteer-email
> Email automation driven by headless chrome.
[](https://www.npmjs.com/package/puppeteer-email) [](https://travis-ci.com/transitive-bullshit/puppeteer-email) [](https://standardjs.com)
## Features
- automate email account creation
- automate email sending
- automate email fetching
- automate email verification from third-party services
- twitter
- github
- facebook
- etc.
- comes with a [library](packages/puppeteer-email) and [CLI](packages/puppeteer-email-cli)
- uses [puppeteer](https://github.com/GoogleChrome/puppeteer) under the hood
- perfect for bots...
## Status
This project is an early WIP, but the [CLI](packages/puppeteer-email-cli) currently works to automate [Outlook](https://outlook.live.com).
## Packages
- [puppeteer-email](packages/puppeteer-email) - Main library entrypoint.
- [puppeteer-email-cli](packages/puppeteer-email-cli) - CLI for executing one-off email automation tasks.
- [puppeteer-email-session](packages/puppeteer-email-session) - Holds state for an authenticated puppeteer email session.
- [puppeteer-email-provider](packages/puppeteer-email-provider) - Abstract base class for puppeteer email providers.
- [puppeteer-email-provider-outlook](packages/puppeteer-email-provider-outlook) - Puppeteer email provider for [Outlook](https://outlook.live.com).
- [puppeteer-email-provider-gmail](packages/puppeteer-email-provider-gmail) - Puppeteer email provider for [Gmail](https://www.google.com/gmail). (TODO)
- [puppeteer-email-provider-yahoo](packages/puppeteer-email-provider-yahoo) - Puppeteer email provider for [Yahoo Mail](https://mail.yahoo.com/). (TODO)
- [parse-email](https://github.com/transitive-bullshit/parse-email) - Parses mime-encoded email messages.
- [sms-number-verifier](https://github.com/transitive-bullshit/sms-number-verifier) - Allows you to spoof SMS number verification.
## Usage
### CLI
```bash
npm install -g puppeteer-email-cli
```
```bash
Usage: puppeteer-email [options] [command]
Options:
-V, --version output the version number
-u, --username email account username
-p, --password email account password
-P, --provider email provider (default: outlook)
-H, --no-headless (puppeteer) disable headless mode
-s, --slow-mo (puppeteer) slows down operations by the given ms (default: 0)
-h, --help output usage information
Commands:
signup [options]
signin
get-emails [options]
```
See the [CLI](packages/puppeteer-email-cli) for more in-depth CLI docs.
### Library
This example signs into an [Outlook](https://outlook.live.com) account, searches for a given query, and then parses and returns all emails returned for that query.
```bash
npm install --save puppeteer-email
```
```js
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:
```js
[
{
"attachments": [ /* ... */ ],
"headers": { /* ... */ },
"html": "\n...",
"text": "...",
"textAsHtml": "
...
",
"subject": "Example email subject",
"date": "2018-05-09T14:17:02.000Z",
"to": {
"value": [
{
"address": "[email protected]",
"name": "Travis Fischer"
}
],
"html": "Travis Fischer <[email protected]>",
"text": "Travis Fischer "
},
"from": {
"value": [
{
"address": "[email protected]",
"name": "GitHub"
}
],
"html": "GitHub <[email protected]>",
"text": "GitHub "
},
"messageId": "<01.B3.11399.xxxxxxxx@momentum1-mta1>"
}
]
```
See the [library](packages/puppeteer-email) for more in-depth library docs.
See [parse-email](https://github.com/transitive-bullshit/parse-email) for details on email model properties.
## Related
- [puppeteer](https://github.com/GoogleChrome/puppeteer) - Headless Chrome Node API used under the hood.
- [parse-email](https://github.com/transitive-bullshit/parse-email) - Parses mime-encoded email messages.
- [sms-number-verifier](https://github.com/transitive-bullshit/sms-number-verifier) - Allows you to spoof SMS number verification.
- [puppeteer-github](https://github.com/transitive-bullshit/puppeteer-github) - GitHub automation driven by headless chrome.
- [awesome-puppeteer](https://github.com/transitive-bullshit/awesome-puppeteer) - A curated list of awesome puppeteer resources.
## 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](https://github.com/transitive-bullshit)
Support my OSS work by following me on twitter 