https://github.com/gugazimmermann/node-gmail-tester

A simple Node.js Gmail client to be used with Cypres
https://github.com/gugazimmermann/node-gmail-tester

automation cypress cypress-io cypress-plugin email gmail-api gmail-checker google-api nodejs

Last synced: 6 months ago
JSON representation

A simple Node.js Gmail client to be used with Cypres

• Host: GitHub
• URL: https://github.com/gugazimmermann/node-gmail-tester
• Owner: gugazimmermann
• License: mit
• Created: 2022-06-07T19:04:46.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-06-09T18:03:20.000Z (about 4 years ago)
• Last Synced: 2025-10-28T14:59:53.466Z (9 months ago)
• Topics: automation, cypress, cypress-io, cypress-plugin, email, gmail-api, gmail-checker, google-api, nodejs
• Language: JavaScript
• Homepage:
• Size: 92.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# node-gmail-tester

[![npm version](https://badge.fury.io/js/node-gmail-tester.svg)](https://www.npmjs.com/package/node-gmail-tester) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A Node.js Gmail client which returns email from any Gmail account.


## Usage

Install using `npm`:

```bash

npm install --save-dev node-gmail-tester

```

```bash

yarn add --dev node-gmail-tester

```

* Create a Google Cloud Project ().

* Create the Access Credentials and make sure to select `Desktop app` for the application type. ().

* Make sure you have enabled Gmail API for the progect.

* Save the Google Cloud Platform OAuth2 Authentication file named `gmail.credentials.json` in the root of the project folder.

* To create the tokens run the following command in the root of the project and follow the instructions, this will create the file `gmail.token.json`.

```bash

node node_modules/node-gmail-tester/init

```

⛔️ **Never share or commit `gmail.credentials.json` nor `gmail.token.json`!**

## Credits

* Built using [googleapis](https://github.com/googleapis/googleapis).