1.0.23

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,21 +18,23 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # test stage
@@ -41,37 +43,40 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci command npm run build
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -85,18 +90,20 @@ codequality:
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
   stage: metadata
@@ -107,6 +114,7 @@ pages:
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -114,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojoio/mailgun",
-  "version": "1.0.17",
+  "version": "1.0.23",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -248,9 +248,9 @@
       }
     },
     "@pushrocks/smartmail": {
-      "version": "1.0.8",
+      "version": "1.0.11",
-      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartmail/-/smartmail-1.0.8.tgz",
+      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartmail/-/smartmail-1.0.11.tgz",
-      "integrity": "sha512-ILUmtrJ0TlBe183/LXmJYAq268NueB6A0vA75qqR9+DeZjBAuYOcIAJxLOXyxtMcG/pSnr+AKTDBzsRn/RMz1g==",
+      "integrity": "sha512-m6qtwoaDXp/2IAmWEccMGhkAtl8cTncBIm1bJo7bKr9GqWvNmnJi8ObnyjzDFFxbtYnmyYbipmo3Blj+i3m/2g==",
       "requires": {
         "@pushrocks/smartfile": "^7.0.6",
         "@pushrocks/smartmustache": "^2.0.9"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojoio/mailgun",
-  "version": "1.0.17",
+  "version": "1.0.23",
   "private": false,
   "description": "an api abstraction package for mailgun",
   "main": "dist/index.js",
@@ -23,7 +23,7 @@
   },
   "dependencies": {
     "@pushrocks/smartfile": "^7.0.6",
-    "@pushrocks/smartmail": "^1.0.8",
+    "@pushrocks/smartmail": "^1.0.11",
     "@pushrocks/smartrequest": "^1.1.47",
     "@pushrocks/smartstring": "^3.0.17"
   },

test/test.ts

@@ -5,12 +5,13 @@ import * as smartmail from '@pushrocks/smartmail';
 const testQenv = new Qenv('./', './.nogit');
 
 import * as mailgun from '../ts/index';
+import { IMailgunMessage } from '../ts/index';
 
 
 let testMailgunAccount: mailgun.MailgunAccount;
-let testSmartmail: smartmail.Smartmail;
+let testSmartmail: smartmail.Smartmail<IMailgunMessage>;
 
-tap.test('first test', async () => {
+tap.test('should create a mailgun account', async () => {
   testMailgunAccount = new mailgun.MailgunAccount(testQenv.getEnvVarOnDemand('MAILGUN_API_TOKEN'));
   expect(testMailgunAccount).to.be.instanceOf(mailgun.MailgunAccount);
 });
@@ -30,9 +31,11 @@ tap.test('should send a smartmail', async () => {
 
 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==');
-  result.options.subject = 'hi there. This is a testmail with attachment';
+  if (result) {
-  result.options.from = 'noreply@mail.lossless.com';
+    result.options.subject = 'hi there. This is a testmail with attachment';
-  testMailgunAccount.sendSmartMail(result, 'sandbox@mail.git.zone');
+    result.options.from = 'noreply@mail.lossless.com';
+    testMailgunAccount.sendSmartMail(result, 'sandbox@mail.git.zone');
+  }
 });
 
 tap.start();

ts/index.ts

@@ -1 +1,2 @@
 export * from './mailgun.classes.account';
+export * from './interfaces';

ts/interfaces/index.ts

@@ -1 +1,2 @@
 export * from './message';
+export * from './notification';

ts/interfaces/message.ts

@@ -15,14 +15,14 @@ export interface IMailgunMessage {
   'X-Gm-Message-State': string;
   'body-plain': string;
   attachments: Array<{
-      url: string,
+    url: string;
-      'content-type': string,
+    'content-type': string;
-      name: string,
+    name: string;
-      size: number
+    size: number;
-    }>;
+  }>;
   'body-html': string;
   'Mime-Version': string;
-  Date: string,
+  Date: string;
   'Message-Id': string;
   'Content-Type': string;
   'X-Google-Smtp-Source': string;

ts/interfaces/notification.ts

@@ -0,0 +1,47 @@
+export interface IMailgunNotification {
+  timestamp: string;
+  token: string;
+  signature: string;
+  domain: string;
+  'Received-Spf': string;
+  From: string;
+  'Return-Path': string;
+  'Arc-Seal': string[],
+  'Delivered-To': string;
+  'X-Google-Dkim-Signature': string;
+  To: string;
+  'Dkim-Signature': string;
+  subject: string;
+  from: string;
+  'X-Received': string[];
+  'Ironport-Sdr': string;
+  'Arc-Authentication-Results': string[];
+  'Arc-Message-Signature': string[];
+  Date: string;
+  'Message-Id': string;
+  'Mime-Version': string;
+  Received: string[];
+  'Authentication-Results': string[];
+  'X-Ipas-Result': string;
+  'message-url': string;
+  'message-headers': string;
+  'Reply-To': string;
+  recipient: string;
+  sender: string;
+  'X-Mailgun-Incoming': string;
+  'X-Forwarded-For': string;
+  'X-Gm-Message-State': string;
+  'X-Google-Smtp-Source': string;
+  'X-Envelope-From': string;
+  'Content-Type': string;
+  'X-Forwarded-To': string;
+  Subject: string;
+  attachments: string;
+  'body-plain': string;
+  'stripped-text': string;
+  'stripped-html': string;
+  'stripped-signature': string;
+
+  // Lossless specific
+  "X-Lossless-Auth": string;
+}

ts/mailgun.classes.account.ts

@@ -51,7 +51,7 @@ export class MailgunAccount {
   /**
    * sends a SmartMail
    */
-  public async sendSmartMail(smartmailArg: plugins.smartmail.Smartmail, toArg: string, dataArg = {}) {
+  public async sendSmartMail(smartmailArg: plugins.smartmail.Smartmail<interfaces.IMailgunMessage>, toArg: string, dataArg = {}) {
     const domain = smartmailArg.options.from.split('@')[1];
     const formFields: plugins.smartrequest.IFormField[] = [
       {
@@ -98,22 +98,29 @@ export class MailgunAccount {
 
   public async retrieveSmartMailFromMessageUrl(messageUrlArg: string) {
     const response = await this.getRequest(messageUrlArg);
+    if (response.statusCode === 404) {
+      console.log(response.body.message);
+      return null;
+    }
     const responseBody: interfaces.IMailgunMessage = response.body;
-    const smartmail = new plugins.smartmail.Smartmail({
+    const smartmail = new plugins.smartmail.Smartmail<interfaces.IMailgunMessage>({
       from: responseBody.From,
       body: responseBody["body-html"],
       subject: responseBody.Subject,
+      creationObjectRef: responseBody
     });
 
     // lets care about attachments
-    for (const attachmentInfo of responseBody.attachments) {
+    if (responseBody.attachments && responseBody.attachments instanceof Array) {
-      const attachmentName = attachmentInfo.name;
+      for (const attachmentInfo of responseBody.attachments) {
-      const attachmentContents = await this.getRequest(attachmentInfo.url, true);
+        const attachmentName = attachmentInfo.name;
-      smartmail.addAttachment(new plugins.smartfile.Smartfile({
+        const attachmentContents = await this.getRequest(attachmentInfo.url, true);
-        path: `./${attachmentName}`,
+        smartmail.addAttachment(new plugins.smartfile.Smartfile({
-        base: `./${attachmentName}`,
+          path: `./${attachmentName}`,
-        contentBuffer: attachmentContents.body
+          base: `./${attachmentName}`,
-      }));
+          contentBuffer: attachmentContents.body
+        }));
+      }
     }
 
     return smartmail;