Compare commits
16 Commits
Author | SHA1 | Date | |
---|---|---|---|
13e064207f | |||
5d4b0eff68 | |||
29a7472b3c | |||
5490be1033 | |||
6ee7c6af76 | |||
aa1750524b | |||
da7c57165e | |||
708c05d1e3 | |||
58b7f602bd | |||
23507b83fc | |||
c160cfd94e | |||
920399a495 | |||
168cb9d5d7 | |||
f61e119912 | |||
f5c3fc6ee6 | |||
6643b9c3dd |
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
dist_*/
|
||||
|
||||
# custom
|
@ -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,24 @@ stages:
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
- npmci git mirror
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- 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:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
@ -41,37 +44,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 +91,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 +115,7 @@ pages:
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
@ -114,5 +123,5 @@ pages:
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
- public
|
||||
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": {
|
||||
"type": "object",
|
||||
"description": "settings for gitzone"
|
||||
"description": "settings for gitzone",
|
||||
"properties": {
|
||||
"projectType": {
|
||||
"type": "string",
|
||||
"enum": ["website", "element", "service", "npm"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1,5 +1,6 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "mojoio",
|
||||
|
777
package-lock.json
generated
777
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
25
package.json
25
package.json
@ -1,37 +1,38 @@
|
||||
{
|
||||
"name": "@mojoio/mailgun",
|
||||
"version": "1.0.18",
|
||||
"version": "1.0.26",
|
||||
"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/tsbuild": "^2.1.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",
|
||||
"@pushrocks/tapbundle": "^3.2.1",
|
||||
"@types/node": "^13.13.4",
|
||||
"tslint": "^6.1.1",
|
||||
"tslint-config-prettier": "^1.15.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/smartfile": "^7.0.6",
|
||||
"@pushrocks/smartmail": "^1.0.8",
|
||||
"@pushrocks/smartfile": "^7.0.12",
|
||||
"@pushrocks/smartmail": "^1.0.11",
|
||||
"@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",
|
||||
|
27
readme.md
27
readme.md
@ -8,16 +8,29 @@ an api abstraction package for mailgun
|
||||
* [docs (typedoc)](https://mojoio.gitlab.io/mailgun/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/mojoio/mailgun/commits/master)
|
||||
[](https://gitlab.com/mojoio/mailgun/commits/master)
|
||||
[](https://www.npmjs.com/package/@mojoio/mailgun)
|
||||
[](https://snyk.io/test/npm/@mojoio/mailgun)
|
||||
[](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
|
||||
|
||||
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)
|
||||
|
24
test/test.ts
24
test/test.ts
@ -5,12 +5,12 @@ 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,21 +18,25 @@ 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',
|
||||
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 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==');
|
||||
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');
|
||||
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();
|
||||
|
@ -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;
|
||||
|
@ -6,13 +6,13 @@ 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;
|
||||
'Dkim-Signature': string;
|
||||
subject: 'Booking confirmation (Order 12PN8P)';
|
||||
from: 'buchungsbestaetigung@bahn.de';
|
||||
subject: string;
|
||||
from: string;
|
||||
'X-Received': string[];
|
||||
'Ironport-Sdr': string;
|
||||
'Arc-Authentication-Results': string[];
|
||||
@ -32,13 +32,16 @@ export interface IMailgunNotification {
|
||||
'X-Forwarded-For': string;
|
||||
'X-Gm-Message-State': string;
|
||||
'X-Google-Smtp-Source': string;
|
||||
'X-Envelope-From': '<phil+caf_=invoiceinbox=mail.lossless.one@lossless.com>';
|
||||
'Content-Type': 'multipart/mixed; boundary="----=_Part_220882_156025801.1578848484963"';
|
||||
'X-Forwarded-To': 'invoiceinbox@mail.lossless.one';
|
||||
'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;
|
||||
}
|
@ -12,14 +12,12 @@ 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'
|
||||
}
|
||||
};
|
||||
@ -38,9 +36,7 @@ export class MailgunAccount {
|
||||
requestUrl,
|
||||
{
|
||||
headers: {
|
||||
Authorization: `Basic ${plugins.smartstring.base64.encode(
|
||||
`api:${this.apiToken}`
|
||||
)}`
|
||||
Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`
|
||||
}
|
||||
},
|
||||
formFields
|
||||
@ -51,8 +47,12 @@ export class MailgunAccount {
|
||||
/**
|
||||
* sends a SmartMail
|
||||
*/
|
||||
public async sendSmartMail(smartmailArg: plugins.smartmail.Smartmail, 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',
|
||||
@ -98,22 +98,31 @@ export class MailgunAccount {
|
||||
|
||||
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({
|
||||
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
|
||||
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
|
||||
}));
|
||||
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;
|
||||
|
Reference in New Issue
Block a user