Compare commits
10 Commits
Author | SHA1 | Date | |
---|---|---|---|
13e064207f | |||
5d4b0eff68 | |||
29a7472b3c | |||
5490be1033 | |||
6ee7c6af76 | |||
aa1750524b | |||
da7c57165e | |||
708c05d1e3 | |||
58b7f602bd | |||
23507b83fc |
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
|||||||
|
|
||||||
# builds
|
# builds
|
||||||
dist/
|
dist/
|
||||||
dist_web/
|
dist_*/
|
||||||
dist_serve/
|
|
||||||
dist_ts_web/
|
|
||||||
|
|
||||||
# custom
|
# custom
|
@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|||||||
|
|
||||||
cache:
|
cache:
|
||||||
paths:
|
paths:
|
||||||
- .npmci_cache/
|
- .npmci_cache/
|
||||||
key: "$CI_BUILD_STAGE"
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- security
|
- security
|
||||||
- test
|
- test
|
||||||
- release
|
- release
|
||||||
- metadata
|
- metadata
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# security stage
|
# security stage
|
||||||
@ -18,21 +18,24 @@ stages:
|
|||||||
mirror:
|
mirror:
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci git mirror
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
snyk:
|
audit:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci command npm install -g snyk
|
|
||||||
- npmci command npm install --ignore-scripts
|
- 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:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# test stage
|
# test stage
|
||||||
@ -41,37 +44,40 @@ snyk:
|
|||||||
testStable:
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
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/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- priv
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
testBuild:
|
testBuild:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
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/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm publish
|
- npmci npm publish
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# metadata stage
|
# metadata stage
|
||||||
@ -85,18 +91,20 @@ codequality:
|
|||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- priv
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
trigger:
|
trigger:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci trigger
|
- npmci trigger
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
@ -107,6 +115,7 @@ pages:
|
|||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command tsdoc
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
only:
|
only:
|
||||||
@ -114,5 +123,5 @@ pages:
|
|||||||
artifacts:
|
artifacts:
|
||||||
expire_in: 1 week
|
expire_in: 1 week
|
||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
4
.snyk
Normal file
4
.snyk
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
||||||
|
version: v1.13.5
|
||||||
|
ignore: {}
|
||||||
|
patch: {}
|
8
.vscode/settings.json
vendored
8
.vscode/settings.json
vendored
@ -11,7 +11,13 @@
|
|||||||
},
|
},
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "settings for gitzone"
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm"]
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
{
|
{
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "mojoio",
|
"gitscope": "mojoio",
|
||||||
|
777
package-lock.json
generated
777
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
23
package.json
23
package.json
@ -1,37 +1,38 @@
|
|||||||
{
|
{
|
||||||
"name": "@mojoio/mailgun",
|
"name": "@mojoio/mailgun",
|
||||||
"version": "1.0.21",
|
"version": "1.0.26",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "an api abstraction package for mailgun",
|
"description": "an api abstraction package for mailgun",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(tstest test/)",
|
||||||
"build": "(tsbuild)",
|
"build": "(tsbuild --web)",
|
||||||
"format": "(gitzone format)"
|
"format": "(gitzone format)"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.0.22",
|
"@gitzone/tsbuild": "^2.1.22",
|
||||||
"@gitzone/tstest": "^1.0.15",
|
"@gitzone/tstest": "^1.0.15",
|
||||||
"@pushrocks/qenv": "^4.0.6",
|
"@pushrocks/qenv": "^4.0.6",
|
||||||
"@pushrocks/tapbundle": "^3.2.0",
|
"@pushrocks/tapbundle": "^3.2.1",
|
||||||
"@types/node": "^13.1.6",
|
"@types/node": "^13.13.4",
|
||||||
"tslint": "^5.20.1",
|
"tslint": "^6.1.1",
|
||||||
"tslint-config-prettier": "^1.15.0"
|
"tslint-config-prettier": "^1.15.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/smartfile": "^7.0.6",
|
"@pushrocks/smartfile": "^7.0.12",
|
||||||
"@pushrocks/smartmail": "^1.0.11",
|
"@pushrocks/smartmail": "^1.0.11",
|
||||||
"@pushrocks/smartrequest": "^1.1.47",
|
"@pushrocks/smartrequest": "^1.1.47",
|
||||||
"@pushrocks/smartstring": "^3.0.17"
|
"@pushrocks/smartstring": "^3.0.18"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
"ts_web/**/*",
|
"ts_web/**/*",
|
||||||
"dist/**/*",
|
"dist/**/*",
|
||||||
"dist_web/**/*",
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
"dist_ts_web/**/*",
|
"dist_ts_web/**/*",
|
||||||
"assets/**/*",
|
"assets/**/*",
|
||||||
"cli.js",
|
"cli.js",
|
||||||
|
27
readme.md
27
readme.md
@ -8,16 +8,29 @@ an api abstraction package for mailgun
|
|||||||
* [docs (typedoc)](https://mojoio.gitlab.io/mailgun/)
|
* [docs (typedoc)](https://mojoio.gitlab.io/mailgun/)
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
[](https://gitlab.com/mojoio/mailgun/commits/master)
|
|
||||||
[](https://gitlab.com/mojoio/mailgun/commits/master)
|
Status Category | Status Badge
|
||||||
[](https://www.npmjs.com/package/@mojoio/mailgun)
|
-- | --
|
||||||
[](https://snyk.io/test/npm/@mojoio/mailgun)
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
npm | [](https://lossless.cloud)
|
||||||
[](https://prettier.io/)
|
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
|
## 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.
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
13
test/test.ts
13
test/test.ts
@ -7,7 +7,6 @@ const testQenv = new Qenv('./', './.nogit');
|
|||||||
import * as mailgun from '../ts/index';
|
import * as mailgun from '../ts/index';
|
||||||
import { IMailgunMessage } from '../ts/index';
|
import { IMailgunMessage } from '../ts/index';
|
||||||
|
|
||||||
|
|
||||||
let testMailgunAccount: mailgun.MailgunAccount;
|
let testMailgunAccount: mailgun.MailgunAccount;
|
||||||
let testSmartmail: smartmail.Smartmail<IMailgunMessage>;
|
let testSmartmail: smartmail.Smartmail<IMailgunMessage>;
|
||||||
|
|
||||||
@ -19,22 +18,24 @@ tap.test('should create a mailgun account', async () => {
|
|||||||
tap.test('should create a smartmail', async () => {
|
tap.test('should create a smartmail', async () => {
|
||||||
testSmartmail = new smartmail.Smartmail({
|
testSmartmail = new smartmail.Smartmail({
|
||||||
body: 'hi there. This is the body.',
|
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;
|
return testSmartmail;
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should send a smartmail', async () => {
|
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 () => {
|
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) {
|
if (result) {
|
||||||
result.options.subject = 'hi there. This is a testmail with attachment';
|
result.options.subject = 'hi there. This is a testmail with attachment';
|
||||||
result.options.from = 'noreply@mail.lossless.com';
|
result.options.from = 'noreply@mail.lossless.com';
|
||||||
testMailgunAccount.sendSmartMail(result, 'sandbox@mail.git.zone');
|
await testMailgunAccount.sendSmartMail(result, 'Sandbox Team <sandbox@mail.git.zone>');
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -15,14 +15,14 @@ export interface IMailgunMessage {
|
|||||||
'X-Gm-Message-State': string;
|
'X-Gm-Message-State': string;
|
||||||
'body-plain': string;
|
'body-plain': string;
|
||||||
attachments: Array<{
|
attachments: Array<{
|
||||||
url: string,
|
url: string;
|
||||||
'content-type': string,
|
'content-type': string;
|
||||||
name: string,
|
name: string;
|
||||||
size: number
|
size: number;
|
||||||
}>;
|
}>;
|
||||||
'body-html': string;
|
'body-html': string;
|
||||||
'Mime-Version': string;
|
'Mime-Version': string;
|
||||||
Date: string,
|
Date: string;
|
||||||
'Message-Id': string;
|
'Message-Id': string;
|
||||||
'Content-Type': string;
|
'Content-Type': string;
|
||||||
'X-Google-Smtp-Source': string;
|
'X-Google-Smtp-Source': string;
|
||||||
|
@ -6,7 +6,7 @@ export interface IMailgunNotification {
|
|||||||
'Received-Spf': string;
|
'Received-Spf': string;
|
||||||
From: string;
|
From: string;
|
||||||
'Return-Path': string;
|
'Return-Path': string;
|
||||||
'Arc-Seal': string[],
|
'Arc-Seal': string[];
|
||||||
'Delivered-To': string;
|
'Delivered-To': string;
|
||||||
'X-Google-Dkim-Signature': string;
|
'X-Google-Dkim-Signature': string;
|
||||||
To: string;
|
To: string;
|
||||||
@ -43,5 +43,5 @@ export interface IMailgunNotification {
|
|||||||
'stripped-signature': string;
|
'stripped-signature': string;
|
||||||
|
|
||||||
// Lossless specific
|
// Lossless specific
|
||||||
X-Lossless-Auth: string
|
'X-Lossless-Auth': string;
|
||||||
}
|
}
|
||||||
|
@ -12,14 +12,12 @@ export class MailgunAccount {
|
|||||||
public async getRequest(routeArg: string, binaryArg: boolean = false) {
|
public async getRequest(routeArg: string, binaryArg: boolean = false) {
|
||||||
let requestUrl = routeArg;
|
let requestUrl = routeArg;
|
||||||
const needsBaseUrlPrefix = !routeArg.startsWith('https://');
|
const needsBaseUrlPrefix = !routeArg.startsWith('https://');
|
||||||
needsBaseUrlPrefix ? requestUrl = `${this.baseUrl}${routeArg}` : null;
|
needsBaseUrlPrefix ? (requestUrl = `${this.baseUrl}${routeArg}`) : null;
|
||||||
console.log(requestUrl);
|
console.log(requestUrl);
|
||||||
const requestOptions: plugins.smartrequest.ISmartRequestOptions = {
|
const requestOptions: plugins.smartrequest.ISmartRequestOptions = {
|
||||||
method: 'GET',
|
method: 'GET',
|
||||||
headers: {
|
headers: {
|
||||||
Authorization: `Basic ${plugins.smartstring.base64.encode(
|
Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`,
|
||||||
`api:${this.apiToken}`
|
|
||||||
)}`,
|
|
||||||
'Content-Type': 'application/json'
|
'Content-Type': 'application/json'
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@ -38,9 +36,7 @@ export class MailgunAccount {
|
|||||||
requestUrl,
|
requestUrl,
|
||||||
{
|
{
|
||||||
headers: {
|
headers: {
|
||||||
Authorization: `Basic ${plugins.smartstring.base64.encode(
|
Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`
|
||||||
`api:${this.apiToken}`
|
|
||||||
)}`
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
formFields
|
formFields
|
||||||
@ -51,8 +47,12 @@ export class MailgunAccount {
|
|||||||
/**
|
/**
|
||||||
* sends a SmartMail
|
* sends a SmartMail
|
||||||
*/
|
*/
|
||||||
public async sendSmartMail(smartmailArg: plugins.smartmail.Smartmail<interfaces.IMailgunMessage>, toArg: string, dataArg = {}) {
|
public async sendSmartMail(
|
||||||
const domain = smartmailArg.options.from.split('@')[1];
|
smartmailArg: plugins.smartmail.Smartmail<interfaces.IMailgunMessage>,
|
||||||
|
toArg: string,
|
||||||
|
dataArg = {}
|
||||||
|
) {
|
||||||
|
const domain = smartmailArg.options.from.split('@')[1].replace('>', '');
|
||||||
const formFields: plugins.smartrequest.IFormField[] = [
|
const formFields: plugins.smartrequest.IFormField[] = [
|
||||||
{
|
{
|
||||||
name: 'from',
|
name: 'from',
|
||||||
@ -105,8 +105,9 @@ export class MailgunAccount {
|
|||||||
const responseBody: interfaces.IMailgunMessage = response.body;
|
const responseBody: interfaces.IMailgunMessage = response.body;
|
||||||
const smartmail = new plugins.smartmail.Smartmail<interfaces.IMailgunMessage>({
|
const smartmail = new plugins.smartmail.Smartmail<interfaces.IMailgunMessage>({
|
||||||
from: responseBody.From,
|
from: responseBody.From,
|
||||||
body: responseBody["body-html"],
|
body: responseBody['body-html'],
|
||||||
subject: responseBody.Subject,
|
subject: responseBody.Subject,
|
||||||
|
creationObjectRef: responseBody
|
||||||
});
|
});
|
||||||
|
|
||||||
// lets care about attachments
|
// lets care about attachments
|
||||||
@ -114,17 +115,19 @@ export class MailgunAccount {
|
|||||||
for (const attachmentInfo of responseBody.attachments) {
|
for (const attachmentInfo of responseBody.attachments) {
|
||||||
const attachmentName = attachmentInfo.name;
|
const attachmentName = attachmentInfo.name;
|
||||||
const attachmentContents = await this.getRequest(attachmentInfo.url, true);
|
const attachmentContents = await this.getRequest(attachmentInfo.url, true);
|
||||||
smartmail.addAttachment(new plugins.smartfile.Smartfile({
|
smartmail.addAttachment(
|
||||||
path: `./${attachmentName}`,
|
new plugins.smartfile.Smartfile({
|
||||||
base: `./${attachmentName}`,
|
path: `./${attachmentName}`,
|
||||||
contentBuffer: attachmentContents.body
|
base: `./${attachmentName}`,
|
||||||
}));
|
contentBuffer: attachmentContents.body
|
||||||
|
})
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return smartmail;
|
return smartmail;
|
||||||
}
|
}
|
||||||
|
|
||||||
public async retrieveSmartMailFromNotifyPayload(notifyPayloadArg: any) {
|
public async retrieveSmartMailFromNotifyPayload(notifyPayloadArg: any) {
|
||||||
return await this.retrieveSmartMailFromMessageUrl(notifyPayloadArg['message-url']);
|
return await this.retrieveSmartMailFromMessageUrl(notifyPayloadArg['message-url']);
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user