1.0.25

.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

.gitlab/.gitlab-webide.yml

@@ -1,5 +1,5 @@
 terminal:
-  image: registry.gitlab.com/hosttoday/ht-docker-node
+  image: registry.gitlab.com/hosttoday/ht-docker-node:stable
   before_script:
     - npm install -g npm-check
   variables:

.snyk

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

npmextra.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojoio/mailgun",
-  "version": "1.0.13",
+  "version": "1.0.25",
   "private": false,
   "description": "an api abstraction package for mailgun",
   "main": "dist/index.js",
@@ -13,18 +13,19 @@
     "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",
+    "@pushrocks/tapbundle": "^3.2.1",
-    "@types/node": "^12.11.7",
+    "@types/node": "^13.13.4",
-    "tslint": "^5.11.0",
+    "tslint": "^6.1.1",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/smartmail": "^1.0.6",
+    "@pushrocks/smartfile": "^7.0.12",
-    "@pushrocks/smartrequest": "^1.1.41",
+    "@pushrocks/smartmail": "^1.0.11",
-    "@pushrocks/smartstring": "^3.0.14"
+    "@pushrocks/smartrequest": "^1.1.47",
+    "@pushrocks/smartstring": "^3.0.18"
   },
   "files": [
     "ts/**/*",

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);
 });
@@ -18,14 +19,23 @@ 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',
+    from: 'Lossless GmbH <noreply@mail.lossless.com>',
-    subject: 'hi there. This is the subject'
+    subject: 'TestMessage from @mojoio/mailgun test'
   });
   return testSmartmail;
 });
 
 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 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,9 +9,12 @@ export class MailgunAccount {
     this.apiToken = apiTokenArg;
   }
 
-  public getRequest(routeArg: string) {
+  public async getRequest(routeArg: string, binaryArg: boolean = false) {
-    const requestUrl = `${this.baseUrl}${routeArg}`; // TODO;
+    let requestUrl = routeArg;
-    const response = plugins.smartrequest.request(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(
@@ -18,7 +22,14 @@ export class MailgunAccount {
         )}`,
         '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[]) {
@@ -40,8 +51,8 @@ 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 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',
@@ -78,7 +91,42 @@ export class MailgunAccount {
     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 };