# emailq

> MailQ is an open source email server compatiable with Amazon SES APIs

Latest version **0.2.5** (published 2018-05-15) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install emailq
pnpm add emailq
yarn add emailq
bun add emailq
```

Provides the command `emailq`.

## 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.2.5 |
| Published | 2018-05-15 |
| First published | 2018-04-26 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 30.2 KB |
| Known vulnerabilities | 0 (+30 in 4 direct dependencies) |
| Install scripts | yes |
| Author | Quezx |
| Maintainers | maddybyakodi, manjeshpv |
| Keywords | email |

## Links

- npm: https://www.npmjs.com/package/emailq
- Repository: https://github.com/manjeshpv/emailq
- Homepage: https://github.com/manjeshpv/emailq#readme
- Issues: https://github.com/manjeshpv/emailq/issues
- npm.io page: https://npm.io/package/emailq

## Dependencies (10)

- [dotenv](https://npm.io/package/dotenv.md) ^5.0.1
- [sqlite](https://npm.io/package/sqlite.md) ^2.9.1
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.232.1
- [express](https://npm.io/package/express.md) ^4.16.3
- [sequelize](https://npm.io/package/sequelize.md) ^4.37.6
- [supertest](https://npm.io/package/supertest.md) ^3.0.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.0.11
- [nodemailer](https://npm.io/package/nodemailer.md) ^3.1.1
- [sequelize-cli](https://npm.io/package/sequelize-cli.md) ^4.0.0
- [nodemailer-html-to-text](https://npm.io/package/nodemailer-html-to-text.md) ^2.1.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.2.5 (latest) — 2018-05-15
- 0.2.4 — 2018-05-15
- 0.2.3 — 2018-05-15
- 0.2.2 — 2018-05-15
- 0.2.1 — 2018-05-15
- 0.2.0 — 2018-05-14
- 0.1.6 — 2018-05-03
- 0.1.5 — 2018-05-02
- 0.1.4 — 2018-05-02
- 0.1.3 — 2018-05-02
- 0.1.2 — 2018-05-02
- 0.1.1 — 2018-05-02
- 0.1.0 — 2018-05-02
- 0.0.9 — 2018-05-02
- 0.0.8 — 2018-05-02
- … 7 more at https://npm.io/package/emailq/versions

## README

# EmailQ

EmailQ is an open source email server compatible with Amazon SES APIs

# Emailq Server Installation

Step 1 : Create  .emailq file and add the following
```sh 
  ## Postal SMTP
  SMTP_HOST=smtp.gmail.com
  SMTP_SECURE=false
  SMTP_IGNORETLS=true
  SMTP_PORT=587
  SMTP_AUTH_USER='majeshpv@gmail.com'
  SMTP_AUTH_PASS='screat'
```

Step 2 : Install node version 8.1.11 or greater
```sh
yum install nodejs
npm install -g n
n lts

```

Step 4 : Install emailq.
```sh
npm install -g emailq
```

Step 5: Run emailq manually

```sh
emailq
```

Step 6: Run emailq on systemd

```sh
cd /etc/nginx/conf.d/
sudo nano ses.example.com.conf

Paste the following 

server {
 listen  80;
 server_name    ses.example.com;
 return         301 https://$server_name$request_uri;
}

server {
  listen 443 ssl;
  #include /etc/nginx/statsd;
  server_name ses.example.com;
  ssl on;
  ssl_certificate /etc/nginx/ssl/ssl-bundle.crt;
  ssl_certificate_key /etc/nginx/ssl/example.com-ssl.key;

    location / {
        proxy_pass http://127.0.0.1:1587;
    }
  }

# test nginx settings
sudo nginx -t
sudo systemctl restart nginx.
sudo systemctl status nginx.
```

Step 7: Create systemd unit: Systemd will keep emailq up and running

```sh
cd /etc/systemd/system
sudo nano emailq.service

Paste the following code

[Unit]
Description=EmailQ
After=syslog.target

[Service]
WorkingDirectory=/home/mail.google.com
ExecStart=/usr/local/bin/node node_modules/emailq/bin/emailq
ExecReload=/usr/bin/kill -HUP $MAINPID
Restart=always
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=emailq
User=
Group=gloryque

[Install]
WantedBy=multi-user.target

# to check unit status
sudo systemctl status emailq

# start emailq on startup
sudo systemctl enable emailq

# start emailq now
sudo systemctl start emailq

# check emailq running status
sudo systemctl status emailq

## to check fo error
journalctl -u emailq -f
journalctl -u emailq -l
```

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