mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-02-15 21:32:48 +00:00
feat: add logger
This commit is contained in:
Anselm Stordeur
346
src/SMTP.ts
Normal file
346
src/SMTP.ts
Normal file
@@ -0,0 +1,346 @@
|
||||
/*
|
||||
* Copyright (C) 2018 StApps
|
||||
* This program is free software: you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License as published by the Free
|
||||
* Software Foundation, version 3.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||
* more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along with
|
||||
* this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
import * as nodemailer from 'nodemailer';
|
||||
import { MailOptions } from 'nodemailer/lib/sendmail-transport';
|
||||
import { Logger } from './Logger';
|
||||
import { TransportWithVerification } from './Transport';
|
||||
|
||||
/**
|
||||
* A configuration of the transport used to send mails via SMTP
|
||||
*/
|
||||
export interface SMTPConfig {
|
||||
auth: {
|
||||
password: string;
|
||||
user: string;
|
||||
};
|
||||
cc?: string[];
|
||||
host: string;
|
||||
port: number;
|
||||
recipients: string[];
|
||||
secure?: boolean;
|
||||
sender: {
|
||||
mail: string;
|
||||
name?: string;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* An implementation of mail transport via SMTP
|
||||
*/
|
||||
export class SMTP extends TransportWithVerification {
|
||||
|
||||
private static _instance: SMTP;
|
||||
|
||||
/**
|
||||
* List of all mail addresses to send in cc
|
||||
*/
|
||||
private cc: string[];
|
||||
|
||||
/**
|
||||
* Who is using this service
|
||||
*/
|
||||
private from: {
|
||||
mail: string;
|
||||
name?: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* List of all mail addresses to send to
|
||||
*/
|
||||
private recipients: string[];
|
||||
|
||||
/**
|
||||
* Connection to SMTP server
|
||||
*/
|
||||
private transportAgent: nodemailer.Transporter;
|
||||
|
||||
/**
|
||||
* Set to true if the transport was verified
|
||||
*/
|
||||
private verified: boolean;
|
||||
|
||||
/**
|
||||
* Get Singleton Instance of the SMTP Transport
|
||||
*
|
||||
* If no config is given it is assumed it will be given via environment variables
|
||||
* SMTP_AUTH_USER: SMTP username
|
||||
* SMTP_AUTH_PASSWORD: SMTP password
|
||||
* SMTP_HOST: SMTP host
|
||||
* SMTP_PORT: SMTP port
|
||||
* SMTP_RECIPIENTS: comma seperated list of recipients
|
||||
* SMTP_CC: comma seperated list of recipients for the carbon copy (CC)
|
||||
* SMTP_SENDER_MAIL: sender of the mail
|
||||
* SMTP_SENDER_NAME: name of the sender
|
||||
* SMTP_SECURE: `true` to enable tls
|
||||
* @param config {SMTPConfig}
|
||||
* @return {Transport}
|
||||
*/
|
||||
public static getInstance(config?: SMTPConfig): SMTP | undefined {
|
||||
// if an instance of SMTP already exists
|
||||
if (this._instance) {
|
||||
return this._instance;
|
||||
}
|
||||
|
||||
// if no config is given, we assume it is set via environment variables
|
||||
if (typeof config === 'undefined') {
|
||||
if (typeof process.env.SMTP_AUTH_USER !== 'string') {
|
||||
throw new Error('User of SMTP configuration is empty. Please provide a user.');
|
||||
}
|
||||
|
||||
if (typeof process.env.SMTP_AUTH_PASSWORD !== 'string') {
|
||||
throw new Error('Password of SMTP configuration is empty. Please provide a password.');
|
||||
}
|
||||
|
||||
if (typeof process.env.SMTP_HOST !== 'string') {
|
||||
throw new Error('Host of SMTP configuration is empty. Please provide a host.');
|
||||
}
|
||||
|
||||
if (typeof process.env.SMTP_PORT !== 'string') {
|
||||
throw new Error('Port of SMTP configuration is empty. Please provide a port.');
|
||||
}
|
||||
|
||||
if (typeof process.env.SMTP_RECIPIENTS !== 'string') {
|
||||
throw new Error('Recipients of SMTP configuration is empty. Please provide at least one recipient.');
|
||||
}
|
||||
|
||||
if (typeof process.env.SMTP_SENDER_MAIL !== 'string') {
|
||||
throw new Error('Sender of SMTP configuration is empty. Please provide a sender.');
|
||||
}
|
||||
|
||||
if (typeof process.env.SMTP_SENDER_NAME !== 'string') {
|
||||
throw new Error('Name of sender of SMTP configuration is empty. Please provide a name for the sender.');
|
||||
}
|
||||
|
||||
config = {
|
||||
auth: {
|
||||
password: process.env.SMTP_AUTH_PASSWORD,
|
||||
user: process.env.SMTP_AUTH_USER,
|
||||
},
|
||||
cc: ((typeof process.env.SMTP_CC === 'string') ? (process.env.SMTP_CC as string).split(',') : []),
|
||||
host: process.env.SMTP_HOST,
|
||||
port: parseInt(process.env.SMTP_PORT, 10),
|
||||
recipients: (typeof process.env.SMTP_RECIPIENTS === 'string') ?
|
||||
(process.env.SMTP_RECIPIENTS).split(',') :
|
||||
[],
|
||||
secure: (typeof process.env.SMTP_SECURE === 'string') ? (process.env.SMTP_SECURE === 'true') : false,
|
||||
sender: {
|
||||
mail: process.env.SMTP_SENDER_MAIL,
|
||||
name: process.env.SMTP_SENDER_NAME,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
// monitoring is not required -> SMTP init can fail
|
||||
if (!Logger.isProductiveEnvironment() || process.env.ALLOW_NO_TRANSPORT === 'true') {
|
||||
try {
|
||||
this._instance = new this(config);
|
||||
} catch (err) {
|
||||
/* tslint:disable-next-line:no-console */
|
||||
console.warn('SMTP config failed.');
|
||||
return;
|
||||
}
|
||||
} else {
|
||||
// monitoring is required -> SMTP will throw error if config is invalid
|
||||
this._instance = new this(config);
|
||||
}
|
||||
|
||||
return this._instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* This checks email addresses to be compatible with new standards. RFC 3490 introduced some features that are not
|
||||
* implemented by every mail transfer agent (MTA).
|
||||
*
|
||||
* For more information please consider reading
|
||||
* https://stackoverflow.com/a/2071250
|
||||
*
|
||||
* @param {string} address
|
||||
* @return {boolean}
|
||||
*/
|
||||
public static isValidEmailAddress(address: string): boolean {
|
||||
|
||||
if (typeof address !== 'string') {
|
||||
return false;
|
||||
}
|
||||
|
||||
// tslint:disable-next-line:max-line-length
|
||||
const regex = /^(([^<>()\[\]\.,;:\s@\"]+(\.[^<>()\[\]\.,;:\s@\"]+)*)|(\".+\"))@(([^<>()[\]\.,;:\s@\"]+\.)+[^<>()[\]\.,;:\s@\"]{2,})$/i;
|
||||
return regex.test(address);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks a list of mail addresses for validity.
|
||||
* @param {string[]} recipients
|
||||
* @return {string[]}
|
||||
*/
|
||||
public static isValidRecipientsList(recipients: string[]): boolean {
|
||||
return Array.isArray(recipients) && recipients.length > 0 && recipients.every(this.isValidEmailAddress);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an SMTP connection. WARNING: This class is supposed to be used as a singleton. You should never
|
||||
* call `new SMTP()`
|
||||
* @param {SMTPConfig} config
|
||||
*/
|
||||
private constructor(config: SMTPConfig) {
|
||||
if (typeof config.host !== 'string') {
|
||||
throw new Error('SMTP configuration needs a host.');
|
||||
}
|
||||
|
||||
if (typeof config.port !== 'number') {
|
||||
throw new Error('SMTP configuration needs a port.');
|
||||
}
|
||||
|
||||
if (typeof config.auth !== 'object') {
|
||||
throw new Error('SMTP configuration needs an auth object.');
|
||||
}
|
||||
|
||||
if (typeof config.auth.user !== 'string') {
|
||||
throw new Error('SMTP auth configuration needs a user');
|
||||
}
|
||||
|
||||
if (typeof config.auth.password !== 'string') {
|
||||
throw new Error('SMTP auth configuration needs a password');
|
||||
}
|
||||
|
||||
if (Array.isArray(config.recipients) && config.recipients.length < 1) {
|
||||
throw new Error('SMTP configuration needs recipients.');
|
||||
}
|
||||
|
||||
if (typeof config.sender.mail !== 'string') {
|
||||
throw new Error('SMTP configuration needs a sender');
|
||||
}
|
||||
|
||||
super();
|
||||
|
||||
if (SMTP.isValidRecipientsList(config.recipients)) {
|
||||
this.recipients = config.recipients;
|
||||
} else {
|
||||
throw new Error('Invalid recipients found');
|
||||
}
|
||||
|
||||
if (typeof config.cc !== 'undefined') {
|
||||
if (SMTP.isValidRecipientsList(config.cc) || (Array.isArray(config.cc) && config.cc.length === 0)) {
|
||||
this.cc = config.cc;
|
||||
} else {
|
||||
throw new Error('Invalid cc recipients found');
|
||||
}
|
||||
} else {
|
||||
this.cc = [];
|
||||
}
|
||||
|
||||
this.from = config.sender;
|
||||
|
||||
this.verified = false;
|
||||
|
||||
// creating transport with configuration
|
||||
this.transportAgent = nodemailer.createTransport({
|
||||
auth: {
|
||||
pass: config.auth.password,
|
||||
user: config.auth.user,
|
||||
},
|
||||
host: config.host,
|
||||
port: config.port,
|
||||
secure: typeof config.secure === 'boolean' ? config.secure : false,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if instance was verified at least once
|
||||
* @returns {boolean}
|
||||
*/
|
||||
public isVerified(): boolean {
|
||||
return this.verified;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a preconfigured mail with recipients and sender configured on
|
||||
* creation of the class (set by environment or on creation of this class)
|
||||
* @param {string} subject
|
||||
* @param {string} message
|
||||
*/
|
||||
public async send(subject: string, message: string): Promise<string> {
|
||||
return await this.sendMail({
|
||||
cc: this.cc,
|
||||
// use an address block if name is available, mail otherwise
|
||||
from: (typeof this.from.name !== 'string') ? `${this.from.name} <${this.from.mail}>` : this.from.mail,
|
||||
subject: subject,
|
||||
text: message,
|
||||
to: this.recipients,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a mail object
|
||||
* @param {MailOptions} mail
|
||||
*/
|
||||
public async sendMail(mail: MailOptions): Promise<string> {
|
||||
// info is the response of the smtp server
|
||||
let info = await this.transportAgent.sendMail(mail);
|
||||
|
||||
// it can be undefined (empty response)
|
||||
if (typeof info === 'undefined') {
|
||||
info = 'Successfully sent mail';
|
||||
}
|
||||
|
||||
// or not of type string
|
||||
if (typeof info !== 'string') {
|
||||
info = JSON.stringify(info);
|
||||
}
|
||||
|
||||
return info;
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify authentication with SMTP server
|
||||
*
|
||||
*
|
||||
* @throws error if you are in a productive environment and don't set ALLOW_NO_TRANSPORT to true
|
||||
* @returns true if the transport is valid
|
||||
*/
|
||||
public async verify(): Promise<boolean> {
|
||||
|
||||
let verificationSuccessfull: boolean = false;
|
||||
|
||||
try {
|
||||
verificationSuccessfull = await this.transportAgent.verify();
|
||||
} catch (err) {
|
||||
if (!Logger.isProductiveEnvironment() || process.env.ALLOW_NO_TRANSPORT !== 'true') {
|
||||
throw err;
|
||||
} else {
|
||||
/* tslint:disable-next-line:no-console */
|
||||
console.warn(
|
||||
'SMTP verification error was ignored, because tranport failures are allowed: ',
|
||||
err.message,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if (!verificationSuccessfull) {
|
||||
if (!Logger.isProductiveEnvironment() || process.env.ALLOW_NO_TRANSPORT !== 'true') {
|
||||
throw new Error(
|
||||
'Verification of SMTP transport failed.' +
|
||||
'If you want to ignore this error set' +
|
||||
'`NODE_ENV=dev` or `ALLOW_NO_TRANSPORT=true`',
|
||||
);
|
||||
} else {
|
||||
/* tslint:disable-next-line:no-console */
|
||||
console.warn('SMTP verification error was ignored, because tranport failures are allowed.');
|
||||
}
|
||||
}
|
||||
this.verified = verificationSuccessfull;
|
||||
return verificationSuccessfull;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user