Compare commits
18 Commits
Author | SHA1 | Date | |
---|---|---|---|
ff5ab4def0 | |||
b418c11827 | |||
e643cf714e | |||
5a82307afe | |||
9abbcac166 | |||
5db2cd1077 | |||
3de9178cd0 | |||
2b1f8a2718 | |||
2117c2f5d9 | |||
ca0daf2454 | |||
ad6d18d306 | |||
7ddcd88862 | |||
9d6b7f3b29 | |||
8be9fc38b6 | |||
6bb3bb7d9a | |||
7fcbd39166 | |||
1e38d6564d | |||
9b3c0e88da |
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
dist_*/
|
||||
|
||||
# custom
|
@ -24,13 +24,14 @@ mirror:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
snyk:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
|
||||
audit:
|
||||
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
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
|
29
.vscode/launch.json
vendored
Normal file
29
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,29 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
}
|
||||
]
|
||||
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
||||
{
|
||||
"json.schemas": [
|
||||
{
|
||||
"fileMatch": ["/npmextra.json"],
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"npmci": {
|
||||
"type": "object",
|
||||
"description": "settings for npmci"
|
||||
},
|
||||
"gitzone": {
|
||||
"type": "object",
|
||||
"description": "settings for gitzone",
|
||||
"properties": {
|
||||
"projectType": {
|
||||
"type": "string",
|
||||
"enum": ["website", "element", "service", "npm"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
@ -7,6 +7,7 @@
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
|
4521
package-lock.json
generated
4521
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
28
package.json
28
package.json
@ -1,35 +1,37 @@
|
||||
{
|
||||
"name": "@pushrocks/smartmail",
|
||||
"version": "1.0.7",
|
||||
"version": "1.0.16",
|
||||
"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.2.0",
|
||||
"@types/node": "^13.1.6",
|
||||
"tslint": "^5.20.1",
|
||||
"@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/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_web/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
|
22
readme.md
22
readme.md
@ -8,16 +8,24 @@ a unified format for representing and dealing with mails
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartmail/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartmail/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartmail/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/smartmail)
|
||||
[](https://snyk.io/test/npm/@pushrocks/smartmail)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://prettier.io/)
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
|
||||
## Usage
|
||||
|
||||
Use TypeScript for best in class intellisense!
|
||||
|
||||
## Contribution
|
||||
|
||||
|
13
test/test.ts
13
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',
|
||||
|
@ -1 +1,2 @@
|
||||
export * from './smartmail.classes.smartmail';
|
||||
export * from './smartmail.classes.emailaddressvalidator';
|
||||
|
19
ts/smartmail.classes.emailaddressvalidator.ts
Normal file
19
ts/smartmail.classes.emailaddressvalidator.ts
Normal file
@ -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'
|
||||
};
|
||||
}
|
||||
}
|
@ -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;
|
||||
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);
|
||||
|
@ -1,4 +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 };
|
||||
|
Reference in New Issue
Block a user