# forsaken-mail

> Forsaken-Mail ============== A self-hosted disposable mail service

Latest version **1.0.0** (published 2016-01-05) · GPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install forsaken-mail
pnpm add forsaken-mail
yarn add forsaken-mail
bun add forsaken-mail
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-01-05 |
| First published | 2016-01-05 |
| Weekly downloads | 0 |
| License | GPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Hongcai Deng |
| Maintainers | denghongcai |

## Links

- npm: https://www.npmjs.com/package/forsaken-mail
- Repository: https://github.com/denghongcai/forrsaken-mail
- Homepage: https://github.com/denghongcai/forrsaken-mail#readme
- Issues: https://github.com/denghongcai/forrsaken-mail/issues
- npm.io page: https://npm.io/package/forsaken-mail

## Dependencies (6)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [mailin](https://npm.io/package/mailin.md) ^3.0.2
- [express](https://npm.io/package/express.md) ^4.13.3
- [shortid](https://npm.io/package/shortid.md) ^2.2.4
- [socket.io](https://npm.io/package/socket.io.md) ^1.3.7
- [body-parser](https://npm.io/package/body-parser.md) ^1.14.2

## Recent versions

- 1.0.0 (latest) — 2016-01-05

## README

Forsaken-Mail
==============
A self-hosted disposable mail service

### Installation

#### Setting up your DNS correctly

In order to receive emails, your smtp server address should be made available somewhere. Two records should be added to your DNS records. Let us pretend that we want to receive emails at ```*@subdomain.domain.com```:
* First an MX record: ```subdomain.domain.com MX 10 mxsubdomain.domain.com```. This means that the mail server for addresses like ```*@subdomain.domain.com``` will be ```mxsubdomain.domain.com```.
* Then an A record: ```mxsubdomain.domain.com A the.ip.address.of.your.mailin.server```. This tells at which ip address the mail server can be found.

You can fire up Mailin (see next section) and use an [smtp server tester](http://mxtoolbox.com/diagnostic.aspx) to verify that everything is correct.

#### Let's Go
general way:
```
npm install && npm start
```
if you want to run this inside a docker container
```
docker build -t denghongcai/forsaken-mail .
docker run --name forsaken-mail -d -p 25:25 -p 3000:3000 denghongcai/forsaken-mail
```
Open your browser and type in
```
http://localhost:3000
```

Enjoy!

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