1.0.30

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -19,22 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-snyk:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -49,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -62,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -84,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.snyk

@@ -0,0 +1,4 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.5
+ignore: {}
+patch: {}

.vscode/settings.json

@@ -11,7 +11,13 @@
           },
           "gitzone": {
             "type": "object",
-            "description": "settings for gitzone"
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
           }
         }
       }

npmextra.json

@@ -1,5 +1,6 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "mojoio",

package.json

@@ -1,41 +1,46 @@
 {
   "name": "@mojoio/mailgun",
-  "version": "1.0.23",
+  "version": "1.0.30",
   "private": false,
   "description": "an api abstraction package for mailgun",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/qenv": "^4.0.6",
-    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^13.1.6",
-    "tslint": "^5.20.1",
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tstest": "^1.0.44",
+    "@pushrocks/qenv": "^4.0.10",
+    "@pushrocks/tapbundle": "^3.2.9",
+    "@types/node": "^14.0.27",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.6",
-    "@pushrocks/smartmail": "^1.0.11",
+    "@pushrocks/smartfile": "^8.0.0",
+    "@pushrocks/smartmail": "^1.0.18",
     "@pushrocks/smartrequest": "^1.1.47",
-    "@pushrocks/smartstring": "^3.0.17"
+    "@pushrocks/smartsmtp": "^1.0.8",
+    "@pushrocks/smartstring": "^3.0.18"
   },
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

qenv.yml

@@ -1,2 +1,3 @@
 required:
   - MAILGUN_API_TOKEN
+  - MAILGUN_SMTP_CREDENTIALS

readme.md

@@ -8,16 +8,29 @@ an api abstraction package for mailgun
 * [docs (typedoc)](https://mojoio.gitlab.io/mailgun/)
 
 ## Status for master
-[![build status](https://gitlab.com/mojoio/mailgun/badges/master/build.svg)](https://gitlab.com/mojoio/mailgun/commits/master)
-[![coverage report](https://gitlab.com/mojoio/mailgun/badges/master/coverage.svg)](https://gitlab.com/mojoio/mailgun/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/mailgun.svg)](https://www.npmjs.com/package/@mojoio/mailgun)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/mailgun/badge.svg)](https://snyk.io/test/npm/@mojoio/mailgun)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/mojoio/mailgun/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/mojoio/mailgun/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@mojoio/mailgun)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/mojoio/mailgun)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@mojoio/mailgun)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@mojoio/mailgun)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@mojoio/mailgun)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
+Use TypeScript for best in class intellisense.
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

test/test.ts

@@ -7,34 +7,48 @@ const testQenv = new Qenv('./', './.nogit');
 import * as mailgun from '../ts/index';
 import { IMailgunMessage } from '../ts/index';
 
-
 let testMailgunAccount: mailgun.MailgunAccount;
 let testSmartmail: smartmail.Smartmail<IMailgunMessage>;
 
 tap.test('should create a mailgun account', async () => {
   testMailgunAccount = new mailgun.MailgunAccount(testQenv.getEnvVarOnDemand('MAILGUN_API_TOKEN'));
+  testMailgunAccount.addSmtpCredentials(testQenv.getEnvVarOnDemand('MAILGUN_SMTP_CREDENTIALS'));
   expect(testMailgunAccount).to.be.instanceOf(mailgun.MailgunAccount);
 });
 
 tap.test('should create a smartmail', async () => {
   testSmartmail = new smartmail.Smartmail({
     body: 'hi there. This is the body.',
-    from: 'noreply@mail.lossless.com',
-    subject: 'hi there. This is the subject'
+    from: 'Lossless GmbH <noreply@mail.lossless.com>',
+    subject: 'TestMessage from @mojoio/mailgun test',
   });
-  return testSmartmail;
+  expect(testSmartmail).to.be.instanceOf(smartmail.Smartmail);
 });
 
 tap.test('should send a smartmail', async () => {
-  testMailgunAccount.sendSmartMail(testSmartmail, 'sandbox@mail.git.zone');
+  await testMailgunAccount.sendSmartMail(testSmartmail, 'Sandbox Team <sandbox@mail.git.zone>');
+});
+
+tap.test('should send a smartmail with empty body', async () => {
+  const emptyBodySmartmail = new smartmail.Smartmail<IMailgunMessage>({
+    body: '',
+    from: 'Lossless GmbH <noreply@mail.lossless.one>',
+    subject: 'A message with no body from @mojoio/mailgun test',
+  });
+  await testMailgunAccount.sendSmartMail(
+    emptyBodySmartmail,
+    'Sandbox Team <sandbox@mail.git.zone>'
+  );
 });
 
 tap.test('should retrieve a mail using a retrieval url', async () => {
-  const result = await testMailgunAccount.retrieveSmartMailFromMessageUrl('https://sw.api.mailgun.net/v3/domains/mail.lossless.one/messages/AgMFnnnAKC8xp_dDa79LyoxhloxtaVmnRA==');
+  const result = await testMailgunAccount.retrieveSmartMailFromMessageUrl(
+    'https://sw.api.mailgun.net/v3/domains/mail.lossless.one/messages/AgMFnnnAKC8xp_dDa79LyoxhloxtaVmnRA=='
+  );
   if (result) {
     result.options.subject = 'hi there. This is a testmail with attachment';
     result.options.from = 'noreply@mail.lossless.com';
-    testMailgunAccount.sendSmartMail(result, 'sandbox@mail.git.zone');
+    await testMailgunAccount.sendSmartMail(result, 'Sandbox Team <sandbox@mail.git.zone>');
   }
 });
 

ts/interfaces/notification.ts

@@ -6,7 +6,7 @@ export interface IMailgunNotification {
   'Received-Spf': string;
   From: string;
   'Return-Path': string;
-  'Arc-Seal': string[],
+  'Arc-Seal': string[];
   'Delivered-To': string;
   'X-Google-Dkim-Signature': string;
   To: string;
@@ -43,5 +43,5 @@ export interface IMailgunNotification {
   'stripped-signature': string;
 
   // Lossless specific
-  "X-Lossless-Auth": string;
+  'X-Lossless-Auth': string;
 }

ts/mailgun.classes.account.ts

@@ -5,23 +5,40 @@ export class MailgunAccount {
   public baseUrl = 'https://api.mailgun.net/v3';
   public apiToken: string;
 
+  public smartSmtps: { [domain: string]: plugins.smartsmtp.Smartsmtp } = {};
+
   constructor(apiTokenArg: string) {
     this.apiToken = apiTokenArg;
   }
 
+  /**
+   * allows adding smtp credentials
+   * Format: [domain]|[username]|[password]
+   */
+  public addSmtpCredentials(credentials: string) {
+    const credentialArray = credentials.split('|');
+    if (credentialArray.length !== 3) {
+      throw new Error('credentials are in the wrong format');
+    }
+    this.smartSmtps[credentialArray[0]] = new plugins.smartsmtp.Smartsmtp({
+      smtpServer: 'smtp.mailgun.org',
+      smtpUser: credentialArray[1],
+      smtpPassword: credentialArray[2],
+    });
+  }
+
   public async getRequest(routeArg: string, binaryArg: boolean = false) {
     let requestUrl = routeArg;
     const needsBaseUrlPrefix = !routeArg.startsWith('https://');
-    needsBaseUrlPrefix ? requestUrl = `${this.baseUrl}${routeArg}` : null;
+    needsBaseUrlPrefix ? (requestUrl = `${this.baseUrl}${routeArg}`) : null;
     console.log(requestUrl);
     const requestOptions: plugins.smartrequest.ISmartRequestOptions = {
       method: 'GET',
       headers: {
-        Authorization: `Basic ${plugins.smartstring.base64.encode(
-          `api:${this.apiToken}`
-        )}`,
-        'Content-Type': 'application/json'
-      }
+        Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`,
+        'Content-Type': 'application/json',
+      },
+      keepAlive: false,
     };
     let response: plugins.smartrequest.IExtendedIncomingMessage;
     if (!binaryArg) {
@@ -38,10 +55,9 @@ export class MailgunAccount {
       requestUrl,
       {
         headers: {
-          Authorization: `Basic ${plugins.smartstring.base64.encode(
-            `api:${this.apiToken}`
-          )}`
-        }
+          Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`,
+        },
+        keepAlive: false,
       },
       formFields
     );
@@ -51,29 +67,33 @@ export class MailgunAccount {
   /**
    * sends a SmartMail
    */
-  public async sendSmartMail(smartmailArg: plugins.smartmail.Smartmail<interfaces.IMailgunMessage>, toArg: string, dataArg = {}) {
-    const domain = smartmailArg.options.from.split('@')[1];
+  public async sendSmartMail(
+    smartmailArg: plugins.smartmail.Smartmail<interfaces.IMailgunMessage>,
+    toArg: string,
+    dataArg = {}
+  ) {
+    const domain = smartmailArg.options.from.split('@')[1].replace('>', '');
     const formFields: plugins.smartrequest.IFormField[] = [
       {
         name: 'from',
         type: 'string',
-        payload: smartmailArg.options.from
+        payload: smartmailArg.options.from,
       },
       {
         name: 'to',
         type: 'string',
-        payload: toArg
+        payload: toArg,
       },
       {
         name: 'subject',
         type: 'string',
-        payload: smartmailArg.getSubject(dataArg)
+        payload: smartmailArg.getSubject(dataArg),
       },
       {
         name: 'html',
         type: 'string',
-        payload: smartmailArg.getBody(dataArg)
-      }
+        payload: smartmailArg.getBody(dataArg),
+      },
     ];
 
     console.log(smartmailArg.attachments);
@@ -83,17 +103,40 @@ export class MailgunAccount {
         name: 'attachment',
         type: 'Buffer',
         payload: attachment.contentBuffer,
-        fileName: attachment.parsedPath.base
+        fileName: attachment.parsedPath.base,
       });
     }
 
+    if (smartmailArg.getBody(dataArg)) {
+      console.log('All requirements for API met');
       const response = await this.postFormData(`/${domain}/messages`, formFields);
       if (response.statusCode === 200) {
+        console.log(
+          `Sent mail with subject ${smartmailArg.getSubject(
+            dataArg
+          )} to ${toArg} using the mailgun API`
+        );
         return response.body;
       } else {
         console.log(response.body);
         throw new Error('could not send email');
       }
+    } else {
+      console.log(
+        'An empty body was provided. This does not work via the API, but using SMTP instead.'
+      );
+      const wantedSmartsmtp = this.smartSmtps[domain];
+      if (!wantedSmartsmtp) {
+        console.log('did not find appropriate smtp credentials');
+        return;
+      }
+      wantedSmartsmtp.sendSmartMail(smartmailArg, toArg);
+      console.log(
+        `Sent mail with subject ${smartmailArg.getSubject(
+          dataArg
+        )} to ${toArg} using an smtp transport over Mailgun`
+      );
+    }
   }
 
   public async retrieveSmartMailFromMessageUrl(messageUrlArg: string) {
@@ -105,9 +148,9 @@ export class MailgunAccount {
     const responseBody: interfaces.IMailgunMessage = response.body;
     const smartmail = new plugins.smartmail.Smartmail<interfaces.IMailgunMessage>({
       from: responseBody.From,
-      body: responseBody["body-html"],
+      body: responseBody['body-html'],
       subject: responseBody.Subject,
-      creationObjectRef: responseBody
+      creationObjectRef: responseBody,
     });
 
     // lets care about attachments
@@ -115,11 +158,13 @@ export class MailgunAccount {
       for (const attachmentInfo of responseBody.attachments) {
         const attachmentName = attachmentInfo.name;
         const attachmentContents = await this.getRequest(attachmentInfo.url, true);
-        smartmail.addAttachment(new plugins.smartfile.Smartfile({
+        smartmail.addAttachment(
+          new plugins.smartfile.Smartfile({
             path: `./${attachmentName}`,
             base: `./${attachmentName}`,
-          contentBuffer: attachmentContents.body
-        }));
+            contentBuffer: attachmentContents.body,
+          })
+        );
       }
     }
 

ts/mailgun.plugins.ts

@@ -2,6 +2,7 @@
 import * as smartfile from '@pushrocks/smartfile';
 import * as smartmail from '@pushrocks/smartmail';
 import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartsmtp from '@pushrocks/smartsmtp';
 import * as smartstring from '@pushrocks/smartstring';
 
-export { smartfile, smartmail, smartrequest, smartstring };
+export { smartfile, smartmail, smartrequest, smartsmtp, smartstring };