test-smtp-server 0.9.6 → 0.9.8

package/README.md

@@ -1,77 +1,77 @@
-# Test SMTP Server
-
-Test SMTP Server is a lightweight wrapper for
-[smtp-server](<https://nodemailer.com/extras/smtp-server/>).
-It is primarily intended for development and testing.  The test code can start the server, run email tests and then validate the email contents.  It can replace the use of external fake SMTP services which may have availablility issues.
-
-All received emails are stored in an array in the order received.  The emails
-may be viewed as raw data or a parsed object that is easily examined.
-
-## Getting Started
-
-### Prerequisites
-
-Tested on Node v16 with npm v7.
-
-### Installation
-
-```sh
-npm install test-smtp-server --save-dev
-```
-
-### Usage
-
-See [test code](
-https://github.com/webstech/test-smtp-server/blob/main/test/index.ts) for an example.
-
-```js
-import { testSmtpServer } from "test-smtp-server";
-
-(async (): Promise<void> => {
-  const smtpserver = new testSmtpServer();
-  await smtpserver.startServer();   // start listening
-
-  // send some emails capturing ids ..
-  messageId.push( await sendMail(email, smtpOptions));
-
-  // get emails in sent order
-  const mails = smtpserver.getEmails();
-
-  // validate/dump emails
-
-  if (mails.length) {
-    let entry = 0;
-    for (const mail of mails) {
-      console.log(`Checking mail entry <${entry}>`);
-      console.log(mail.envelope);
-      const parsed = await mail.getParsed();
-      if (parsed.messageId !== messageId[entry]) {
-        throw new Error(`Messageids do not match for email ${
-          entry} <${parsed.messageId}> <${messageId[entry]}>`);
-      }
-
-      console.log(parsed);
-      entry++;
-    }
-  } else {
-    throw new Error("No emails captured when expected");
-  }
-
-  await smtpserver.stopServer();    // terminate server
-```
-
-### Security
-
-The server is started as secure but that may not be possible in the testing
-environment.  If the server does not have a valid certificate, the connection
-will fail from the client side. Some clients
-(e.g. nodemailer/SMTP-Transport options) allow connections to non-secure
-servers.  Node allows connections through an
-environment variable that turns off certificate authorization checking.  See
-[node_tls_reject_unauthorizedvalue](
-https://nodejs.org/api/cli.html#node_tls_reject_unauthorizedvalue)
-for more information.  This may be insecure if other ports are used.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
+# Test SMTP Server
+
+Test SMTP Server is a lightweight wrapper for
+[smtp-server](<https://nodemailer.com/extras/smtp-server/>).
+It is primarily intended for development and testing.  The test code can start the server, run email tests and then validate the email contents.  It can replace the use of external fake SMTP services which may have availablility issues.
+
+All received emails are stored in an array in the order received.  The emails
+may be viewed as raw data or a parsed object that is easily examined.
+
+## Getting Started
+
+### Prerequisites
+
+Tested on Node v18 with npm v9.
+
+### Installation
+
+```sh
+npm install test-smtp-server --save-dev
+```
+
+### Usage
+
+See [test code](
+https://github.com/webstech/test-smtp-server/blob/main/test/index.ts) for an example.
+
+```js
+import { testSmtpServer } from "test-smtp-server";
+
+(async (): Promise<void> => {
+  const smtpserver = new testSmtpServer();
+  await smtpserver.startServer();   // start listening
+
+  // send some emails capturing ids ..
+  messageId.push( await sendMail(email, smtpOptions));
+
+  // get emails in sent order
+  const mails = smtpserver.getEmails();
+
+  // validate/dump emails
+
+  if (mails.length) {
+    let entry = 0;
+    for (const mail of mails) {
+      console.log(`Checking mail entry <${entry}>`);
+      console.log(mail.envelope);
+      const parsed = await mail.getParsed();
+      if (parsed.messageId !== messageId[entry]) {
+        throw new Error(`Messageids do not match for email ${
+          entry} <${parsed.messageId}> <${messageId[entry]}>`);
+      }
+
+      console.log(parsed);
+      entry++;
+    }
+  } else {
+    throw new Error("No emails captured when expected");
+  }
+
+  await smtpserver.stopServer();    // terminate server
+```
+
+### Security
+
+The server is started as secure but that may not be possible in the testing
+environment.  If the server does not have a valid certificate, the connection
+will fail from the client side. Some clients
+(e.g. nodemailer/SMTP-Transport options) allow connections to non-secure
+servers.  Node allows connections through an
+environment variable that turns off certificate authorization checking.  See
+[node_tls_reject_unauthorizedvalue](
+https://nodejs.org/api/cli.html#node_tls_reject_unauthorizedvalue)
+for more information.  This may be insecure if other ports are used.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

package/build/lib/test-smtp-server.d.ts

@@ -1,69 +1,69 @@
-/// <reference types="node" />
-import { SMTPServerEnvelope } from "smtp-server";
-import { ParsedMail } from "mailparser";
-/**
- * Class to describe an email.  The `envelope` contains the SMTP routing
- * information.  This may not match the `to/cc/bcc` information in the
- * email contaents.  The buffer contains the raw email content.  To easily
- * access parts of the email, `getParsed` should be used.
- */
-export declare class eMail {
-    envelope: SMTPServerEnvelope;
-    buffer: Buffer | null;
-    length: number;
-    constructor(envelope: SMTPServerEnvelope, buffer: Buffer);
-    /**
-     * Return a parsed email as formatted by `simpleParser`.
-     *
-     * @returns Promise<ParsedMail>  See
-     * https://nodemailer.com/extras/mailparser/ for the structure.
-     */
-    getParsed(): Promise<ParsedMail>;
-}
-/**
- * testSmtpServer optional parameters
- */
-export type testSmtpServerOptions = {
-    /** the port number to use (default: 1025) */
-    smtpPort?: number;
-    /** restrict ip addresses to localhost */
-    localhostOnly?: boolean;
-    /** logging function like console.log() */
-    debug?: (message?: unknown, ...optionalParams: any[]) => void;
-};
-/**
- * Create a testSmtpServer.  This provides a wrapper to SMTPServer that
- * can be used for testing.  The emails are stored in an array that
- * can be examined to validate the content.
- */
-export declare class testSmtpServer {
-    private debug;
-    private emails;
-    private isDebugging;
-    private localhostOnly;
-    private port;
-    private server;
-    constructor(options?: testSmtpServerOptions | undefined);
-    /**
-     * Clear the set of emails.
-     *
-     * @returns number of emails deleted
-     */
-    clearEmails(): number;
-    /**
-     * Retrieve the set of emails in order from oldest to most recent.
-     *
-     * @returns array of eMail objects
-     */
-    getEmails(): eMail[];
-    /**
-     * Query for the port number used by the server.
-     *
-     * @returns the port number being used
-     */
-    getPort(): number;
-    /** Start the server */
-    startServer(): void;
-    /** Stop the server */
-    stopServer(): void;
-}
+/// <reference types="node" />
+import { SMTPServerEnvelope } from "smtp-server";
+import { ParsedMail } from "mailparser";
+/**
+ * Class to describe an email.  The `envelope` contains the SMTP routing
+ * information.  This may not match the `to/cc/bcc` information in the
+ * email contaents.  The buffer contains the raw email content.  To easily
+ * access parts of the email, `getParsed` should be used.
+ */
+export declare class eMail {
+    envelope: SMTPServerEnvelope;
+    buffer: Buffer | null;
+    length: number;
+    constructor(envelope: SMTPServerEnvelope, buffer: Buffer);
+    /**
+     * Return a parsed email as formatted by `simpleParser`.
+     *
+     * @returns Promise<ParsedMail>  See
+     * https://nodemailer.com/extras/mailparser/ for the structure.
+     */
+    getParsed(): Promise<ParsedMail>;
+}
+/**
+ * testSmtpServer optional parameters
+ */
+export type testSmtpServerOptions = {
+    /** the port number to use (default: 1025) */
+    smtpPort?: number;
+    /** restrict ip addresses to localhost */
+    localhostOnly?: boolean;
+    /** logging function like console.log() */
+    debug?: (message?: unknown, ...optionalParams: any[]) => void;
+};
+/**
+ * Create a testSmtpServer.  This provides a wrapper to SMTPServer that
+ * can be used for testing.  The emails are stored in an array that
+ * can be examined to validate the content.
+ */
+export declare class testSmtpServer {
+    private debug;
+    private emails;
+    private isDebugging;
+    private localhostOnly;
+    private port;
+    private server;
+    constructor(options?: testSmtpServerOptions | undefined);
+    /**
+     * Clear the set of emails.
+     *
+     * @returns number of emails deleted
+     */
+    clearEmails(): number;
+    /**
+     * Retrieve the set of emails in order from oldest to most recent.
+     *
+     * @returns array of eMail objects
+     */
+    getEmails(): eMail[];
+    /**
+     * Query for the port number used by the server.
+     *
+     * @returns the port number being used
+     */
+    getPort(): number;
+    /** Start the server */
+    startServer(): void;
+    /** Stop the server */
+    stopServer(): void;
+}

package/build/lib/test-smtp-server.js

@@ -1,146 +1,146 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.testSmtpServer = exports.eMail = void 0;
-const smtp_server_1 = require("smtp-server");
-const mailparser_1 = require("mailparser");
-const stream_1 = require("stream");
-/**
- * Class to describe an email.  The `envelope` contains the SMTP routing
- * information.  This may not match the `to/cc/bcc` information in the
- * email contaents.  The buffer contains the raw email content.  To easily
- * access parts of the email, `getParsed` should be used.
- */
-class eMail {
-    constructor(envelope, buffer) {
-        this.buffer = null;
-        this.length = 0;
-        this.envelope = envelope;
-        this.buffer = buffer;
-    }
-    /**
-     * Return a parsed email as formatted by `simpleParser`.
-     *
-     * @returns Promise<ParsedMail>  See
-     * https://nodemailer.com/extras/mailparser/ for the structure.
-     */
-    async getParsed() {
-        if (this.buffer) {
-            const stream = stream_1.Readable.from(this.buffer);
-            const options = {
-                skipHtmlToText: true,
-                skipTextLinks: true,
-                skipTextToHtml: true
-            };
-            return (0, mailparser_1.simpleParser)(stream, options);
-        }
-        else {
-            throw new Error("Empty email buffer");
-        }
-    }
-}
-exports.eMail = eMail;
-/**
- * Create a testSmtpServer.  This provides a wrapper to SMTPServer that
- * can be used for testing.  The emails are stored in an array that
- * can be examined to validate the content.
- */
-class testSmtpServer {
-    constructor(options) {
-        // eslint-disable-next-line @typescript-eslint/no-empty-function
-        this.debug = (_message, ..._optionalParams) => { };
-        this.emails = [];
-        this.isDebugging = false;
-        this.localhostOnly = true;
-        this.port = 1025;
-        if (options) {
-            if (options.smtpPort) {
-                this.port = options.smtpPort;
-            }
-            if (options.localhostOnly) {
-                this.localhostOnly = options.localhostOnly;
-            }
-            if (options.debug) {
-                this.debug = options.debug;
-            }
-        }
-        // eslint-disable-next-line @typescript-eslint/no-this-alias
-        const that = this; // preserve for use in other objects
-        this.server = new smtp_server_1.SMTPServer({
-            authOptional: true,
-            onConnect(session, callback) {
-                // 172.17 prefix is a linux docker container
-                if (that.localhostOnly && !session.remoteAddress.match(/^172.17|127.0.0.1|::1$/)) {
-                    return callback(new Error("Only connections from localhost allowed"));
-                }
-                return callback(); // Accept the connection
-            },
-            onAuth(auth, _session, callback) {
-                that.debug(`SMTP login for user: ${auth.username}`);
-                callback(null, { user: auth.username });
-            },
-            onData(stream, session, callback) {
-                const buffers = [];
-                const writer = new stream_1.Writable({
-                    write(data, _encoding, writerCallback) {
-                        buffers.push(data);
-                        writerCallback();
-                    },
-                });
-                stream.pipe(writer);
-                stream.on("end", () => {
-                    const buffer = Buffer.concat(buffers);
-                    const email = new eMail(session.envelope, buffer);
-                    that.emails.push(email);
-                    if (that.isDebugging) {
-                        that.debug(JSON.stringify(email, (key, value) => {
-                            if ("buffer" === key) {
-                                return buffer.toString();
-                            }
-                            else {
-                                return value;
-                            }
-                        }, 2));
-                    }
-                    callback();
-                });
-            },
-            secure: true,
-        });
-    }
-    /**
-     * Clear the set of emails.
-     *
-     * @returns number of emails deleted
-     */
-    clearEmails() {
-        const count = this.emails.length;
-        this.emails.length = 0;
-        return count;
-    }
-    /**
-     * Retrieve the set of emails in order from oldest to most recent.
-     *
-     * @returns array of eMail objects
-     */
-    getEmails() {
-        return this.emails;
-    }
-    /**
-     * Query for the port number used by the server.
-     *
-     * @returns the port number being used
-     */
-    getPort() {
-        return this.port;
-    }
-    /** Start the server */
-    startServer() {
-        this.server.listen(this.port);
-    }
-    /** Stop the server */
-    stopServer() {
-        this.server.close();
-    }
-}
-exports.testSmtpServer = testSmtpServer;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testSmtpServer = exports.eMail = void 0;
+const smtp_server_1 = require("smtp-server");
+const mailparser_1 = require("mailparser");
+const stream_1 = require("stream");
+/**
+ * Class to describe an email.  The `envelope` contains the SMTP routing
+ * information.  This may not match the `to/cc/bcc` information in the
+ * email contaents.  The buffer contains the raw email content.  To easily
+ * access parts of the email, `getParsed` should be used.
+ */
+class eMail {
+    constructor(envelope, buffer) {
+        this.buffer = null;
+        this.length = 0;
+        this.envelope = envelope;
+        this.buffer = buffer;
+    }
+    /**
+     * Return a parsed email as formatted by `simpleParser`.
+     *
+     * @returns Promise<ParsedMail>  See
+     * https://nodemailer.com/extras/mailparser/ for the structure.
+     */
+    async getParsed() {
+        if (this.buffer) {
+            const stream = stream_1.Readable.from(this.buffer);
+            const options = {
+                skipHtmlToText: true,
+                skipTextLinks: true,
+                skipTextToHtml: true
+            };
+            return (0, mailparser_1.simpleParser)(stream, options);
+        }
+        else {
+            throw new Error("Empty email buffer");
+        }
+    }
+}
+exports.eMail = eMail;
+/**
+ * Create a testSmtpServer.  This provides a wrapper to SMTPServer that
+ * can be used for testing.  The emails are stored in an array that
+ * can be examined to validate the content.
+ */
+class testSmtpServer {
+    constructor(options) {
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        this.debug = (_message, ..._optionalParams) => { };
+        this.emails = [];
+        this.isDebugging = false;
+        this.localhostOnly = true;
+        this.port = 1025;
+        if (options) {
+            if (options.smtpPort) {
+                this.port = options.smtpPort;
+            }
+            if (options.localhostOnly) {
+                this.localhostOnly = options.localhostOnly;
+            }
+            if (options.debug) {
+                this.debug = options.debug;
+            }
+        }
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const that = this; // preserve for use in other objects
+        this.server = new smtp_server_1.SMTPServer({
+            authOptional: true,
+            onConnect(session, callback) {
+                // 172.17 prefix is a linux docker container
+                if (that.localhostOnly && !session.remoteAddress.match(/^172.17|127.0.0.1|::1$/)) {
+                    return callback(new Error("Only connections from localhost allowed"));
+                }
+                return callback(); // Accept the connection
+            },
+            onAuth(auth, _session, callback) {
+                that.debug(`SMTP login for user: ${auth.username}`);
+                callback(null, { user: auth.username });
+            },
+            onData(stream, session, callback) {
+                const buffers = [];
+                const writer = new stream_1.Writable({
+                    write(data, _encoding, writerCallback) {
+                        buffers.push(data);
+                        writerCallback();
+                    },
+                });
+                stream.pipe(writer);
+                stream.on("end", () => {
+                    const buffer = Buffer.concat(buffers);
+                    const email = new eMail(session.envelope, buffer);
+                    that.emails.push(email);
+                    if (that.isDebugging) {
+                        that.debug(JSON.stringify(email, (key, value) => {
+                            if ("buffer" === key) {
+                                return buffer.toString();
+                            }
+                            else {
+                                return value;
+                            }
+                        }, 2));
+                    }
+                    callback();
+                });
+            },
+            secure: true,
+        });
+    }
+    /**
+     * Clear the set of emails.
+     *
+     * @returns number of emails deleted
+     */
+    clearEmails() {
+        const count = this.emails.length;
+        this.emails.length = 0;
+        return count;
+    }
+    /**
+     * Retrieve the set of emails in order from oldest to most recent.
+     *
+     * @returns array of eMail objects
+     */
+    getEmails() {
+        return this.emails;
+    }
+    /**
+     * Query for the port number used by the server.
+     *
+     * @returns the port number being used
+     */
+    getPort() {
+        return this.port;
+    }
+    /** Start the server */
+    startServer() {
+        this.server.listen(this.port);
+    }
+    /** Stop the server */
+    stopServer() {
+        this.server.close();
+    }
+}
+exports.testSmtpServer = testSmtpServer;
 //# sourceMappingURL=test-smtp-server.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-smtp-server",
-  "version": "0.9.6",
+  "version": "0.9.8",
   "description": "The test-smtp-server package allows internal testing of projects needing an SMTP server.",
   "main": "./build/lib/test-smtp-server.js",
   "types": "./build/lib/test-smtp-server.d.ts",
@@ -17,7 +17,9 @@
     "lint": "eslint --ignore-path .gitignore -c .eslintrc.js --ext .ts,.js \"{lib,test}/**/*.{ts,tsx,mjs,js}\"",
     "test": "npm run test:ts && npm run test:js",
     "test:ts": "node build/test/index.js",
-    "test:js": "node test/jstest.mjs"
+    "test:js": "node test/jstest.mjs",
+    "preversion": "npm run build && npm test",
+    "postversion": "git push --follow-tags"
   },
   "bugs": {
     "url": "https://github.com/webstech/test-smtp-server/issues"
@@ -44,21 +46,21 @@
     "url": "git+https://github.com/webstech/test-smtp-server"
   },
   "devDependencies": {
-    "@types/nodemailer": "^6.4.7",
+    "@types/nodemailer": "^6.4.9",
     "@types/smtp-server": "^3.5.7",
-    "@typescript-eslint/eslint-plugin": "^5.47.0",
-    "@typescript-eslint/parser": "^5.47.0",
-    "commander": "^9.4.1",
-    "eslint": "^8.30.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jsdoc": "^39.6.4",
-    "nodemailer": "^6.7.5",
-    "typescript": "^4.9.4"
+    "@typescript-eslint/eslint-plugin": "^6.2.1",
+    "@typescript-eslint/parser": "^6.2.1",
+    "commander": "^11.0.0",
+    "eslint": "^8.46.0",
+    "eslint-config-prettier": "^8.9.0",
+    "eslint-plugin-jsdoc": "^46.4.5",
+    "nodemailer": "^6.9.4",
+    "typescript": "^5.1.6"
   },
   "dependencies": {
     "@types/mailparser": "^3.4.0",
-    "mailparser": "^3.6.2",
-    "smtp-server": "^3.11.0"
+    "mailparser": "^3.6.5",
+    "smtp-server": "^3.12.0"
   },
   "engines": {
     "node": ">= 16.0.0"