1.0.26

.gitignore

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

.gitlab-ci.yml

@@ -4,13 +4,13 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -20,17 +20,20 @@ mirror:
   script:
     - npmci git mirror
   tags:
+    - lossless
     - docker
     - notpriv
 
-snyk:
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - 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
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -47,6 +50,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
     - priv
 
@@ -59,6 +63,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -70,6 +75,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -85,6 +91,7 @@ codequality:
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
+    - lossless
     - docker
     - priv
 
@@ -95,6 +102,7 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -107,6 +115,7 @@ pages:
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.gitlab/.gitlab-webide.yml

@@ -0,0 +1,8 @@
+terminal:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:stable
+  before_script:
+    - npm install -g npm-check
+  variables:
+    RAILS_ENV: "test"
+    NODE_ENV: "test"
+

.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"]
+              }
+            }
           }
         }
       }

npmextra.json

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

package.json

@@ -1,36 +1,38 @@
 {
   "name": "@mojoio/mailgun",
-  "version": "1.0.7",
+  "version": "1.0.26",
   "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/tsbuild": "^2.1.22",
     "@gitzone/tstest": "^1.0.15",
     "@pushrocks/qenv": "^4.0.6",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^12.11.7",
-    "tslint": "^5.11.0",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^13.13.4",
+    "tslint": "^6.1.1",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/smartmail": "^1.0.6",
-    "@pushrocks/smartrequest": "^1.1.41",
-    "@pushrocks/smartstring": "^3.0.14"
+    "@pushrocks/smartfile": "^7.0.12",
+    "@pushrocks/smartmail": "^1.0.11",
+    "@pushrocks/smartrequest": "^1.1.47",
+    "@pushrocks/smartstring": "^3.0.18"
   },
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",

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

@@ -5,12 +5,12 @@ 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);
 });
@@ -18,14 +18,25 @@ tap.test('first test', async () => {
 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;
 });
 
 tap.test('should send a smartmail', async () => {
-  testMailgunAccount.sendSmartMail(testSmartmail, 'phil@lossless.com');
+  await testMailgunAccount.sendSmartMail(testSmartmail, '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=='
+  );
+  if (result) {
+    result.options.subject = 'hi there. This is a testmail with attachment';
+    result.options.from = 'noreply@mail.lossless.com';
+    await testMailgunAccount.sendSmartMail(result, 'Sandbox Team <sandbox@mail.git.zone>');
+  }
 });
 
 tap.start();

ts/index.ts

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

ts/interfaces/index.ts

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

ts/interfaces/message.ts

@@ -0,0 +1,30 @@
+export interface IMailgunMessage {
+  Received: string;
+  From: string;
+  'X-Envelope-From': string;
+  recipients: string;
+  'X-Google-Dkim-Signature': string;
+  To: string;
+  'message-headers': [[string, string]];
+  'Dkim-Signature': string;
+  'content-id-map': any;
+  subject: 'test2';
+  'stripped-html': string;
+  'X-Mailgun-Incoming': 'Yes';
+  'X-Received': string;
+  'X-Gm-Message-State': string;
+  'body-plain': string;
+  attachments: Array<{
+    url: string;
+    'content-type': string;
+    name: string;
+    size: number;
+  }>;
+  'body-html': string;
+  'Mime-Version': string;
+  Date: string;
+  'Message-Id': string;
+  'Content-Type': string;
+  'X-Google-Smtp-Source': string;
+  Subject: 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

@@ -1,4 +1,5 @@
 import * as plugins from './mailgun.plugins';
+import * as interfaces from './interfaces';
 
 export class MailgunAccount {
   public baseUrl = 'https://api.mailgun.net/v3';
@@ -8,17 +9,25 @@ export class MailgunAccount {
     this.apiToken = apiTokenArg;
   }
 
-  public getRequest(routeArg: string) {
-    const requestUrl = `${this.baseUrl}${routeArg}`; // TODO;
-    const response = plugins.smartrequest.request(routeArg, {
+  public async getRequest(routeArg: string, binaryArg: boolean = false) {
+    let requestUrl = routeArg;
+    const needsBaseUrlPrefix = !routeArg.startsWith('https://');
+    needsBaseUrlPrefix ? (requestUrl = `${this.baseUrl}${routeArg}`) : null;
+    console.log(requestUrl);
+    const requestOptions: plugins.smartrequest.ISmartRequestOptions = {
       method: 'GET',
       headers: {
-        Authorization: `Basic ${plugins.smartstring.base64.encode(
-          this.apiToken
-        )}`,
+        Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`,
         'Content-Type': 'application/json'
       }
-    });
+    };
+    let response: plugins.smartrequest.IExtendedIncomingMessage;
+    if (!binaryArg) {
+      response = await plugins.smartrequest.request(requestUrl, requestOptions);
+    } else {
+      response = await plugins.smartrequest.getBinary(requestUrl, requestOptions);
+    }
+    return response;
   }
 
   public async postFormData(routeArg: string, formFields: plugins.smartrequest.IFormField[]) {
@@ -27,9 +36,7 @@ export class MailgunAccount {
       requestUrl,
       {
         headers: {
-          Authorization: `Basic ${plugins.smartstring.base64.encode(
-            `api:key-a049e048b7029b9621c41b5682fadee9`
-          )}`
+          Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`
         }
       },
       formFields
@@ -40,8 +47,12 @@ export class MailgunAccount {
   /**
    * sends a SmartMail
    */
-  public async sendSmartMail(smartmailArg: plugins.smartmail.Smartmail, 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',
@@ -65,6 +76,8 @@ export class MailgunAccount {
       }
     ];
 
+    console.log(smartmailArg.attachments);
+
     for (const attachment of smartmailArg.attachments) {
       formFields.push({
         name: 'attachment',
@@ -75,6 +88,47 @@ export class MailgunAccount {
     }
 
     const response = await this.postFormData(`/${domain}/messages`, formFields);
-    console.log(response);
+    if (response.statusCode === 200) {
+      return response.body;
+    } else {
+      console.log(response.body);
+      throw new Error('could not send email');
+    }
+  }
+
+  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<interfaces.IMailgunMessage>({
+      from: responseBody.From,
+      body: responseBody['body-html'],
+      subject: responseBody.Subject,
+      creationObjectRef: responseBody
+    });
+
+    // lets care about attachments
+    if (responseBody.attachments && responseBody.attachments instanceof Array) {
+      for (const attachmentInfo of responseBody.attachments) {
+        const attachmentName = attachmentInfo.name;
+        const attachmentContents = await this.getRequest(attachmentInfo.url, true);
+        smartmail.addAttachment(
+          new plugins.smartfile.Smartfile({
+            path: `./${attachmentName}`,
+            base: `./${attachmentName}`,
+            contentBuffer: attachmentContents.body
+          })
+        );
+      }
+    }
+
+    return smartmail;
+  }
+
+  public async retrieveSmartMailFromNotifyPayload(notifyPayloadArg: any) {
+    return await this.retrieveSmartMailFromMessageUrl(notifyPayloadArg['message-url']);
   }
 }

ts/mailgun.plugins.ts

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