test-smtp-server 0.9.3 → 0.9.6

package/README.md

@@ -4,7 +4,8 @@ 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.  The emails may be viewed as raw data or a parsed object that is easily examined.
+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
 
@@ -31,8 +32,9 @@ import { testSmtpServer } from "test-smtp-server";
   await smtpserver.startServer();   // start listening
 
   // send some emails capturing ids ..
-  messageId.unshift( await sendMail(email, smtpOptions));
+  messageId.push( await sendMail(email, smtpOptions));
 
+  // get emails in sent order
   const mails = smtpserver.getEmails();
 
   // validate/dump emails

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

@@ -23,9 +23,11 @@ export declare class eMail {
 /**
  * testSmtpServer optional parameters
  */
-export declare type testSmtpServerOptions = {
+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;
 };
@@ -38,6 +40,7 @@ export declare class testSmtpServer {
     private debug;
     private emails;
     private isDebugging;
+    private localhostOnly;
     private port;
     private server;
     constructor(options?: testSmtpServerOptions | undefined);
@@ -48,7 +51,7 @@ export declare class testSmtpServer {
      */
     clearEmails(): number;
     /**
-     * Retrieve the set of emails in order from latest to oldest.
+     * Retrieve the set of emails in order from oldest to most recent.
      *
      * @returns array of eMail objects
      */

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

@@ -50,11 +50,15 @@ class testSmtpServer {
         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;
             }
@@ -64,7 +68,8 @@ class testSmtpServer {
         this.server = new smtp_server_1.SMTPServer({
             authOptional: true,
             onConnect(session, callback) {
-                if (!session.remoteAddress.match(/^127.0.0.1|::1$/)) {
+                // 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
@@ -85,7 +90,7 @@ class testSmtpServer {
                 stream.on("end", () => {
                     const buffer = Buffer.concat(buffers);
                     const email = new eMail(session.envelope, buffer);
-                    that.emails.unshift(email);
+                    that.emails.push(email);
                     if (that.isDebugging) {
                         that.debug(JSON.stringify(email, (key, value) => {
                             if ("buffer" === key) {
@@ -113,7 +118,7 @@ class testSmtpServer {
         return count;
     }
     /**
-     * Retrieve the set of emails in order from latest to oldest.
+     * Retrieve the set of emails in order from oldest to most recent.
      *
      * @returns array of eMail objects
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-smtp-server",
-  "version": "0.9.3",
+  "version": "0.9.6",
   "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",
@@ -44,20 +44,20 @@
     "url": "git+https://github.com/webstech/test-smtp-server"
   },
   "devDependencies": {
-    "@types/nodemailer": "^6.4.4",
+    "@types/nodemailer": "^6.4.7",
     "@types/smtp-server": "^3.5.7",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^5.26.0",
-    "commander": "^9.0.0",
-    "eslint": "^8.2.0",
+    "@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.3.2",
+    "eslint-plugin-jsdoc": "^39.6.4",
     "nodemailer": "^6.7.5",
-    "typescript": "^4.7.2"
+    "typescript": "^4.9.4"
   },
   "dependencies": {
     "@types/mailparser": "^3.4.0",
-    "mailparser": "^3.5.0",
+    "mailparser": "^3.6.2",
     "smtp-server": "^3.11.0"
   },
   "engines": {