1.0.15

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,21 +18,23 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - 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
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
@@ -41,37 +43,40 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -85,18 +90,20 @@ codequality:
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - 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

npmextra.json

@@ -7,6 +7,7 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,29 +1,30 @@
 {
   "name": "@pushrocks/smartmail",
-  "version": "1.0.5",
+  "version": "1.0.15",
   "private": false,
   "description": "a unified format for representing and dealing with mails",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "UNLICENSED",
   "scripts": {
     "test": "(tstest test/)",
     "format": "(gitzone format)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.11.7",
-    "tslint": "^5.20.0",
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.33",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^14.0.13",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.6",
-    "@pushrocks/smartmustache": "^2.0.8"
+    "@pushrocks/smartdns": "^4.0.3",
+    "@pushrocks/smartfile": "^7.0.12",
+    "@pushrocks/smartmustache": "^2.0.9"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -8,7 +8,7 @@ a unified format for representing and dealing with mails
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartmail/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartmail/badges/master/build.svg)](https://gitlab.com/pushrocks/smartmail/commits/master)
+[![pipeline status](https://gitlab.com/pushrocks/smartmail/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartmail/commits/master)
 [![coverage report](https://gitlab.com/pushrocks/smartmail/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartmail/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartmail.svg)](https://www.npmjs.com/package/@pushrocks/smartmail)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartmail/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartmail)
@@ -18,6 +18,13 @@ a unified format for representing and dealing with mails
 
 ## 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

@@ -1,7 +1,18 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartmail from '../ts/index';
 
-tap.test('first test', async () => {
+let emailAddressValidatorInstance: smartmail.EmailAddressValidator;
+
+tap.test('should create an instance of EmailAddressValidator', async () => {
+  emailAddressValidatorInstance = new smartmail.EmailAddressValidator();
+  expect(emailAddressValidatorInstance).to.be.instanceOf(smartmail.EmailAddressValidator);
+});
+
+tap.test('should validate an email', async () => {
+  const result = await emailAddressValidatorInstance.validate('sandbox@bleu.de');
+});
+
+tap.test('should create a SmartMail', async () => {
   const testSmartmail = new smartmail.Smartmail({
     body: 'hi there',
     from: 'noreply@mail.lossless.com',

ts/index.ts

@@ -1 +1,2 @@
 export * from './smartmail.classes.smartmail';
+export * from './smartmail.classes.emailaddressvalidator';

ts/smartmail.classes.emailaddressvalidator.ts

@@ -0,0 +1,19 @@
+import * as plugins from './smartmail.plugins';
+
+export interface IEmailValidationResult {
+  valid: boolean;
+  reason: string;
+}
+
+export class EmailAddressValidator {
+  public smartdns = new plugins.smartdns.Smartdns({});
+
+  public async validate(emailArg: string): Promise<IEmailValidationResult> {
+    const emailArray = emailArg.split('@');
+    const result = await this.smartdns.getRecord(emailArray[1], 'MX');
+    return {
+      valid: !!result,
+      reason: 'todo'
+    };
+  }
+}

ts/smartmail.classes.smartmail.ts

@@ -1,19 +1,20 @@
 import * as plugins from './smartmail.plugins';
 
-export interface ISmartmailOptions {
+export interface ISmartmailOptions<T> {
   from: string;
   subject: string;
   body: string;
+  creationObjectRef?: T;
 }
 
 /**
  * a standard representation for mails
  */
-export class Smartmail {
-  public options: ISmartmailOptions;
-  public attachments: plugins.smartfile.Smartfile[];
+export class Smartmail<T> {
+  public options: ISmartmailOptions<T>;
+  public attachments: plugins.smartfile.Smartfile[] = [];
 
-  constructor(optionsArg: ISmartmailOptions) {
+  constructor(optionsArg: ISmartmailOptions<T>) {
     this.options = optionsArg;
   }
 
@@ -21,6 +22,10 @@ export class Smartmail {
     this.attachments.push(smartfileArg);
   }
 
+  public getCreationObject(): T {
+    return this.options.creationObjectRef;
+  }
+
   public getSubject(dataArg: any = {}) {
     const smartmustache = new plugins.smartmustache.SmartMustache(this.options.subject);
     return smartmustache.applyData(dataArg);

ts/smartmail.plugins.ts

@@ -1,7 +1,5 @@
+import * as smartdns from '@pushrocks/smartdns';
 import * as smartfile from '@pushrocks/smartfile';
 import * as smartmustache from '@pushrocks/smartmustache';
 
-export {
-  smartfile,
-  smartmustache
-};
+export { smartdns, smartfile, smartmustache };