Comparing version 2.0.0-beta2 to 2.0.0-beta3
31
index.js
@@ -15,2 +15,3 @@ | ||
const logger = require('./lib/logger') | ||
const { options, appendOptions } = require('./lib/options') | ||
@@ -22,31 +23,3 @@ module.exports = function (config) { | ||
// CLI | ||
config = program | ||
.version(version) | ||
.option('-s, --smtp <port>', 'SMTP port to catch emails [1025]', process.env.MAILDEV_SMTP_PORT || '1025') | ||
.option('-w, --web <port>', 'Port to run the Web GUI [1080]', process.env.MAILDEV_WEB_PORT || '1080') | ||
.option('--https', 'Switch from http to https protocol', !!process.env.MAILDEV_HTTPS) | ||
.option('--https-key <file>', 'The file path to the ssl private key', process.env.MAILDEV_HTTPS_KEY) | ||
.option('--https-cert <file>', 'The file path to the ssl cert file', process.env.MAILDEV_HTTPS_CERT) | ||
.option('--ip <ip address>', 'IP Address to bind SMTP service to', process.env.MAILDEV_IP || '0.0.0.0') | ||
.option('--outgoing-host <host>', 'SMTP host for outgoing emails', process.env.MAILDEV_OUTGOING_HOST) | ||
.option('--outgoing-port <port>', 'SMTP port for outgoing emails', process.env.MAILDEV_OUTGOING_PORT) | ||
.option('--outgoing-user <user>', 'SMTP user for outgoing emails', process.env.MAILDEV_OUTGOING_USER) | ||
.option('--outgoing-pass <password>', 'SMTP password for outgoing emails', process.env.MAILDEV_OUTGOING_PASS) | ||
.option('--outgoing-secure', 'Use SMTP SSL for outgoing emails', !!process.env.MAILDEV_OUTGOING_SECURE) | ||
.option('--auto-relay [email]', 'Use auto-relay mode. Optional relay email address', process.env.MAILDEV_AUTO_RELAY) | ||
.option('--auto-relay-rules <file>', 'Filter rules for auto relay mode', process.env.MAILDEV_AUTO_RELAY_RULES) | ||
.option('--incoming-user <user>', 'SMTP user for incoming emails', process.env.MAILDEV_INCOMING_USER) | ||
.option('--incoming-pass <pass>', 'SMTP password for incoming emails', process.env.MAILDEV_INCOMING_PASS) | ||
.option('--web-ip <ip address>', 'IP Address to bind HTTP service to, defaults to --ip', process.env.MAILDEV_WEB_IP) | ||
.option('--web-user <user>', 'HTTP user for GUI', process.env.MAILDEV_WEB_USER) | ||
.option('--web-pass <password>', 'HTTP password for GUI', process.env.MAILDEV_WEB_PASS) | ||
.option('--base-pathname <path>', 'base path for URLs', process.env.MAILDEV_BASE_PATHNAME) | ||
.option('--disable-web', 'Disable the use of the web interface. Useful for unit testing', !!process.env.MAILDEV_DISABLE_WEB) | ||
.option('--hide-extensions <extensions>', | ||
'Comma separated list of SMTP extensions to NOT advertise (SMTPUTF8, PIPELINING, 8BITMIME)', | ||
function (val) { return val.split(',') } | ||
) | ||
.option('-o, --open', 'Open the Web GUI after startup') | ||
.option('-v, --verbose') | ||
.option('--silent') | ||
config = appendOptions(program.version(version), options) | ||
.parse(process.argv) | ||
@@ -53,0 +26,0 @@ } |
@@ -59,2 +59,4 @@ 'use strict' | ||
client.on('error', function (err) { logger.error('SMTP Connection error for outgoing email: ', err) }) | ||
logger.info( | ||
@@ -61,0 +63,0 @@ 'MailDev outgoing SMTP Server %s:%d (user:%s, pass:%s, secure:%s)', |
{ | ||
"name": "maildev", | ||
"description": "SMTP Server and Web Interface for reading and testing emails during development", | ||
"version": "2.0.0-beta2", | ||
"version": "2.0.0-beta3", | ||
"keywords": [ | ||
@@ -36,3 +36,4 @@ "email", | ||
"docker-run": "docker run --rm -p 1080:1080 -p 1025:1025 maildev/maildev:$npm_package_version", | ||
"docker-push": "docker push maildev/maildev:$npm_package_version && docker push maildev/maildev:latest" | ||
"docker-push": "docker push maildev/maildev:$npm_package_version && docker push maildev/maildev:latest", | ||
"update-readme": "node ./scripts/updateUsageREADME.js" | ||
}, | ||
@@ -39,0 +40,0 @@ "main": "./index.js", |
@@ -27,55 +27,33 @@ # MailDev | ||
## Usage | ||
``` | ||
Usage: maildev [options] | ||
``` | ||
maildev [options] | ||
|Options|Environment variable|Description| | ||
|---|---|---| | ||
|`-s, --smtp <port>`|`MAILDEV_SMTP_PORT`|SMTP port to catch emails| | ||
|`-w, --web <port>`|`MAILDEV_WEB_PORT`|Port to run the Web GUI| | ||
|`--https`|`MAILDEV_HTTPS`|Switch from http to https protocol| | ||
|`--https-key <file>`|`MAILDEV_HTTPS_KEY`|The file path to the ssl private key| | ||
|`--https-cert <file>`|`MAILDEV_HTTPS_CERT`|The file path to the ssl cert file| | ||
|`--ip <ip address>`|`MAILDEV_IP`|IP Address to bind SMTP service to| | ||
|`--outgoing-host <host>`|`MAILDEV_OUTGOING_HOST`|SMTP host for outgoing emails| | ||
|`--outgoing-port <port>`|`MAILDEV_OUTGOING_PORT`|SMTP port for outgoing emails| | ||
|`--outgoing-user <user>`|`MAILDEV_OUTGOING_USER`|SMTP user for outgoing emails| | ||
|`--outgoing-pass <password>`|`MAILDEV_OUTGOING_PASS`|SMTP password for outgoing emails| | ||
|`--outgoing-secure`|`MAILDEV_OUTGOING_SECURE`|Use SMTP SSL for outgoing emails| | ||
|`--auto-relay [email]`|`MAILDEV_AUTO_RELAY`|Use auto-relay mode. Optional relay email address| | ||
|`--auto-relay-rules <file>`|`MAILDEV_AUTO_RELAY_RULES`|Filter rules for auto relay mode| | ||
|`--incoming-user <user>`|`MAILDEV_INCOMING_USER`|SMTP user for incoming emails| | ||
|`--incoming-pass <pass>`|`MAILDEV_INCOMING_PASS`|SMTP password for incoming emails| | ||
|`--web-ip <ip address>`|`MAILDEV_WEB_IP`|IP Address to bind HTTP service to, defaults to --ip| | ||
|`--web-user <user>`|`MAILDEV_WEB_USER`|HTTP user for GUI| | ||
|`--web-pass <password>`|`MAILDEV_WEB_PASS`|HTTP password for GUI| | ||
|`--base-pathname <path>`|`MAILDEV_BASE_PATHNAME`|base path for URLs| | ||
|`--disable-web`|`MAILDEV_DISABLE_WEB`|Disable the use of the web interface. Useful for unit testing| | ||
|`--hide-extensions <extensions>`|`MAILDEV_HIDE_EXTENSIONS`|Comma separated list of SMTP extensions to NOT advertise (SMTPUTF8, PIPELINING, 8BITMIME)| | ||
|`-o, --open`||Open the Web GUI after startup| | ||
|`-v, --verbose`||| | ||
|`--silent`||| | ||
-h, --help output usage information | ||
-V, --version output the version number | ||
-s, --smtp <port> SMTP port to catch emails [1025] | ||
-w, --web <port> Port to run the Web GUI [1080] | ||
--ip <ip address> IP Address to bind SMTP service to | ||
--outgoing-host <host> SMTP host for outgoing emails | ||
--outgoing-port <port> SMTP port for outgoing emails | ||
--outgoing-user <user> SMTP user for outgoing emails | ||
--outgoing-pass <password> SMTP password for outgoing emails | ||
--outgoing-secure Use SMTP SSL for outgoing emails | ||
--auto-relay [email] Use auto-relay mode. Optional relay email address | ||
--auto-relay-rules <file> Filter rules for auto relay mode | ||
--incoming-user <user> SMTP user for incoming emails | ||
--incoming-pass <pass> SMTP password for incoming emails | ||
--web-ip <ip address> IP Address to bind HTTP service to, defaults to --ip | ||
--web-user <user> HTTP user for GUI | ||
--web-pass <password> HTTP password for GUI | ||
--https Switch from http to https protocol | ||
--https-key <file> The file path to the ssl private key | ||
--https-cert <file> The file path to the ssl cert file | ||
--base-pathname <path> base path for URLs | ||
--disable-web Disable the use of the web interface. Useful for unit testing | ||
--hide-extensions <extensions> Comma separated list of SMTP extensions to NOT advertise | ||
(SMTPUTF8, PIPELINING, 8BITMIME) | ||
-o, --open Open the Web GUI after startup | ||
-v, --verbose | ||
--silent | ||
## Environment variables | ||
MailDev can be configured using the following environment variables: | ||
MAILDEV_SMTP_PORT | ||
MAILDEV_WEB_PORT | ||
MAILDEV_IP | ||
MAILDEV_OUTGOING_HOST | ||
MAILDEV_OUTGOING_PORT | ||
MAILDEV_OUTGOING_USER | ||
MAILDEV_OUTGOING_PASS | ||
MAILDEV_OUTGOING_SECURE | ||
MAILDEV_AUTO_RELAY | ||
MAILDEV_AUTO_RELAY_RULES | ||
MAILDEV_INCOMING_USER | ||
MAILDEV_INCOMING_PASS | ||
MAILDEV_WEB_IP | ||
MAILDEV_WEB_USER | ||
MAILDEV_WEB_PASS | ||
MAILDEV_BASE_PATHNAME | ||
MAILDEV_DISABLE_WEB | ||
## API | ||
@@ -165,11 +143,2 @@ | ||
**Nodemailer (v0.7)** | ||
```javascript | ||
const transport = nodemailer.createTransport('SMTP', { | ||
port: 1025, | ||
// other settings... | ||
}) | ||
``` | ||
**Django** -- Add `EMAIL_PORT = 1025` in your settings file [[source]](https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-EMAIL_PORT) | ||
@@ -176,0 +145,0 @@ |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 20 instances in 1 package
53
29666
4
2284502
211