# simple-google-mail

> A utility for handling authentication and retrieval of google mail data.

Latest version **0.1.5** (published 2019-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-google-mail
pnpm add simple-google-mail
yarn add simple-google-mail
bun add simple-google-mail
```

## 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.5 |
| Published | 2019-07-20 |
| First published | 2019-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Dan Emmons |
| Maintainers | emmonspired |

## Links

- npm: https://www.npmjs.com/package/simple-google-mail
- Repository: https://github.com/emmonspired/simple-google-mail
- Homepage: https://github.com/emmonspired/simple-google-mail#readme
- Issues: https://github.com/emmonspired/simple-google-mail/issues
- npm.io page: https://npm.io/package/simple-google-mail

## Dependencies (3)

- [bluebird](https://npm.io/package/bluebird.md) ^3.5.5
- [googleapis](https://npm.io/package/googleapis.md) ^40.0.0
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.9

## Recent versions

- 0.1.5 (latest) — 2019-07-20
- 0.1.4 — 2019-07-19
- 0.1.3 — 2019-07-19
- 0.1.2 — 2019-07-19
- 0.1.1 — 2019-07-19

## README

# simple-google-mail
A utility for handling authentication and retrieval of google mail data.

## Installation
`npm install simple-google-mail`

## Prerequisite Configuration
Go to https://developers.google.com/gmail/api/quickstart/nodejs and click `ENABLE THE GMAIL API`.
Copy your credentials.json file to the `CREDENTIALS_PATH` specified in the `config` to the `SimpleGoogleMail` constructor.

## Example Usage

First Time Through, the app will prompt you to create the `google-mail-token.json` file by following the steps presented.

```
const {SimpleGoogleMail} = require('simple-google-mail');

const mail = new SimpleGoogleMail({
    SCOPES: ['https://mail.google.com/'],
    CREDENTIALS_PATH: './credentials/google-mail-credentials.json',
    TOKEN_PATH: './credentials/google-mail-token.json',
    MAIL_OUTPUT_PATH: './output/mail'
});

let recentMail = mail.processRecentEmailWithCredentials();
```

---
_Source: https://npm.io/package/simple-google-mail · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._