Compare commits

..

12 Commits

Author SHA1 Message Date
3abc973d88 1.0.27 2020-08-11 14:47:26 +00:00
b08b9abb38 fix(core): update 2020-08-11 14:47:25 +00:00
13e064207f 1.0.26 2020-06-18 22:00:00 +00:00
5d4b0eff68 fix(core): update 2020-06-18 22:00:00 +00:00
29a7472b3c 1.0.25 2020-04-26 23:24:03 +00:00
5490be1033 fix(core): update 2020-04-26 23:24:03 +00:00
6ee7c6af76 1.0.24 2020-01-23 17:31:11 +00:00
aa1750524b fix(core): update 2020-01-23 17:31:10 +00:00
da7c57165e 1.0.23 2020-01-23 16:55:21 +00:00
708c05d1e3 fix(core): update 2020-01-23 16:55:20 +00:00
58b7f602bd 1.0.22 2020-01-21 10:07:07 +00:00
23507b83fc fix(core): update 2020-01-21 10:07:07 +00:00
12 changed files with 10239 additions and 678 deletions

4
.gitignore vendored
View File

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

View File

@ -4,7 +4,7 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: "$CI_BUILD_STAGE"
key: '$CI_BUILD_STAGE'
stages:
- security
@ -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:

4
.snyk Normal file
View File

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

View File

@ -11,7 +11,13 @@
},
"gitzone": {
"type": "object",
"description": "settings for gitzone"
"description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm"]
}
}
}
}
}

View File

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

11182
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,37 +1,38 @@
{
"name": "@mojoio/mailgun",
"version": "1.0.21",
"version": "1.0.27",
"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/tstest": "^1.0.15",
"@pushrocks/qenv": "^4.0.6",
"@pushrocks/tapbundle": "^3.2.0",
"@types/node": "^13.1.6",
"tslint": "^5.20.1",
"@gitzone/tsbuild": "^2.1.25",
"@gitzone/tstest": "^1.0.43",
"@pushrocks/qenv": "^4.0.10",
"@pushrocks/tapbundle": "^3.2.9",
"@types/node": "^14.0.27",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.15.0"
},
"dependencies": {
"@pushrocks/smartfile": "^7.0.6",
"@pushrocks/smartmail": "^1.0.11",
"@pushrocks/smartfile": "^8.0.0",
"@pushrocks/smartmail": "^1.0.18",
"@pushrocks/smartrequest": "^1.1.47",
"@pushrocks/smartstring": "^3.0.17"
"@pushrocks/smartstring": "^3.0.18"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_web/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",

View File

@ -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)

View File

@ -7,7 +7,6 @@ const testQenv = new Qenv('./', './.nogit');
import * as mailgun from '../ts/index';
import { IMailgunMessage } from '../ts/index';
let testMailgunAccount: mailgun.MailgunAccount;
let testSmartmail: smartmail.Smartmail<IMailgunMessage>;
@ -19,22 +18,35 @@ tap.test('should create a mailgun account', 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, 'sandbox@mail.git.zone');
await testMailgunAccount.sendSmartMail(testSmartmail, 'Sandbox Team <sandbox@mail.git.zone>');
});
tap.test('should send a smartmail with empty body', async () => {
const emptyBodySmartmail = new smartmail.Smartmail<IMailgunMessage>({
body: '',
from: 'Lossless GmbH <noreply@mail.lossless.com>',
subject: 'A message with no body from @mojoio/mailgun test'
});
console.log('ok');
await testMailgunAccount.sendSmartMail(emptyBodySmartmail, 'Sandbox Team <sandbox@mail.git.zone>');
console.log('hey');
});
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==');
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';
testMailgunAccount.sendSmartMail(result, 'sandbox@mail.git.zone');
await testMailgunAccount.sendSmartMail(result, 'Sandbox Team <sandbox@mail.git.zone>');
}
});

View File

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

View File

@ -6,7 +6,7 @@ export interface IMailgunNotification {
'Received-Spf': string;
From: string;
'Return-Path': string;
'Arc-Seal': string[],
'Arc-Seal': string[];
'Delivered-To': string;
'X-Google-Dkim-Signature': string;
To: string;
@ -43,5 +43,5 @@ export interface IMailgunNotification {
'stripped-signature': string;
// Lossless specific
X-Lossless-Auth: string
'X-Lossless-Auth': string;
}

View File

@ -12,16 +12,15 @@ export class MailgunAccount {
public async getRequest(routeArg: string, binaryArg: boolean = false) {
let requestUrl = routeArg;
const needsBaseUrlPrefix = !routeArg.startsWith('https://');
needsBaseUrlPrefix ? requestUrl = `${this.baseUrl}${routeArg}` : null;
needsBaseUrlPrefix ? (requestUrl = `${this.baseUrl}${routeArg}`) : null;
console.log(requestUrl);
const requestOptions: plugins.smartrequest.ISmartRequestOptions = {
method: 'GET',
headers: {
Authorization: `Basic ${plugins.smartstring.base64.encode(
`api:${this.apiToken}`
)}`,
Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`,
'Content-Type': 'application/json'
}
},
keepAlive: false
};
let response: plugins.smartrequest.IExtendedIncomingMessage;
if (!binaryArg) {
@ -38,10 +37,9 @@ export class MailgunAccount {
requestUrl,
{
headers: {
Authorization: `Basic ${plugins.smartstring.base64.encode(
`api:${this.apiToken}`
)}`
}
Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`
},
keepAlive: false
},
formFields
);
@ -51,8 +49,12 @@ export class MailgunAccount {
/**
* sends a SmartMail
*/
public async sendSmartMail(smartmailArg: plugins.smartmail.Smartmail<interfaces.IMailgunMessage>, 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',
@ -68,13 +70,23 @@ export class MailgunAccount {
name: 'subject',
type: 'string',
payload: smartmailArg.getSubject(dataArg)
},
{
}
];
if (smartmailArg.getBody(dataArg)) {
formFields.push({
name: 'html',
type: 'string',
payload: smartmailArg.getBody(dataArg)
});
} else {
console.log('message has no body');
formFields.push({
name: 'html',
type: 'string',
payload: 'The sender did not provide a bodytext.'
});
}
];
console.log(smartmailArg.attachments);
@ -105,8 +117,9 @@ export class MailgunAccount {
const responseBody: interfaces.IMailgunMessage = response.body;
const smartmail = new plugins.smartmail.Smartmail<interfaces.IMailgunMessage>({
from: responseBody.From,
body: responseBody["body-html"],
body: responseBody['body-html'],
subject: responseBody.Subject,
creationObjectRef: responseBody
});
// lets care about attachments
@ -114,11 +127,13 @@ export class MailgunAccount {
for (const attachmentInfo of responseBody.attachments) {
const attachmentName = attachmentInfo.name;
const attachmentContents = await this.getRequest(attachmentInfo.url, true);
smartmail.addAttachment(new plugins.smartfile.Smartfile({
smartmail.addAttachment(
new plugins.smartfile.Smartfile({
path: `./${attachmentName}`,
base: `./${attachmentName}`,
contentBuffer: attachmentContents.body
}));
})
);
}
}