https://github.com/0xkheops/webmail4dev
nodejs app composed of a SMTP server plus a web server that shows all emails received by the smtp server, meant for test environments.
https://github.com/0xkheops/webmail4dev
devtool emails nodejs sharepoint smtp-server testing
Last synced: 2 months ago
JSON representation
nodejs app composed of a SMTP server plus a web server that shows all emails received by the smtp server, meant for test environments.
- Host: GitHub
- URL: https://github.com/0xkheops/webmail4dev
- Owner: 0xKheops
- License: mit
- Created: 2017-10-15T18:33:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-20T09:49:55.000Z (almost 8 years ago)
- Last Synced: 2025-08-30T16:08:47.938Z (10 months ago)
- Topics: devtool, emails, nodejs, sharepoint, smtp-server, testing
- Language: JavaScript
- Size: 22.9 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# webmail4dev
webmail4dev is a CLI/service which starts a local smtp server (with no auth) and a web server that displays all emails received by the smtp server, meant for testing environments.
It is meant to be used as an web-based fake mail server for testing applications that send emails, such as SharePoint. Using such a mail server ensures that emails are not sent to real mailboxes, while making it easy for test users to read all outgoing emails at once.
It can be seen as a web alternative to [Papercut](https://github.com/ChangemakerStudios/Papercut) or [smtp4dev](https://github.com/rnwood/smtp4dev).
## Installation
Requires [nodejs](https://nodejs.org/en/download/) 6.X minimum.
### For Linux
Install and run the application :
```bash
# install the cli globally
sudo npm install -g webmail4dev
# either run the program in current thread
# sudo is necessary to open port 25
sudo webmail4dev
# or if you want to run it as a service, then start it
sudo webmail4dev --install
sudo service webmail4dev start
```
### For Windows
[os-service](https://github.com/stephenwvickers/node-os-service) dependency compiles C++ code during install using [node-gyp](https://www.npmjs.com/package/node-gyp), which requires python to be installed and it's path to be registered in the node environment. The easiest way to meet these requirements on windows is to install windows-build-tools.
```bash
# FOR WINDOWS ONLY
# requires "Run as administrator" prompt
npm install --global --production windows-build-tools
# install the cli globally
npm install -g webmail4dev
# either run the program in current thread
webmail4dev
# or if you want to run it as a service
# requires "Run as administrator" prompt
webmail4dev --install
net start webmail4dev
```
### Options
Run this command to see a list of all available options:
```bash
webmail4dev --help
```