123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423 |
- 'use strict';
- const EventEmitter = require('events');
- const shared = require('../shared');
- const mimeTypes = require('../mime-funcs/mime-types');
- const MailComposer = require('../mail-composer');
- const DKIM = require('../dkim');
- const httpProxyClient = require('../smtp-connection/http-proxy-client');
- const util = require('util');
- const urllib = require('url');
- const packageData = require('../../package.json');
- const MailMessage = require('./mail-message');
- const net = require('net');
- const dns = require('dns');
- const crypto = require('crypto');
- /**
- * Creates an object for exposing the Mail API
- *
- * @constructor
- * @param {Object} transporter Transport object instance to pass the mails to
- */
- class Mail extends EventEmitter {
- constructor(transporter, options, defaults) {
- super();
- this.options = options || {};
- this._defaults = defaults || {};
- this._defaultPlugins = {
- compile: [(...args) => this._convertDataImages(...args)],
- stream: []
- };
- this._userPlugins = {
- compile: [],
- stream: []
- };
- this.meta = new Map();
- this.dkim = this.options.dkim ? new DKIM(this.options.dkim) : false;
- this.transporter = transporter;
- this.transporter.mailer = this;
- this.logger = shared.getLogger(this.options, {
- component: this.options.component || 'mail'
- });
- this.logger.debug(
- {
- tnx: 'create'
- },
- 'Creating transport: %s',
- this.getVersionString()
- );
- // setup emit handlers for the transporter
- if (typeof this.transporter.on === 'function') {
- // deprecated log interface
- this.transporter.on('log', log => {
- this.logger.debug(
- {
- tnx: 'transport'
- },
- '%s: %s',
- log.type,
- log.message
- );
- });
- // transporter errors
- this.transporter.on('error', err => {
- this.logger.error(
- {
- err,
- tnx: 'transport'
- },
- 'Transport Error: %s',
- err.message
- );
- this.emit('error', err);
- });
- // indicates if the sender has became idle
- this.transporter.on('idle', (...args) => {
- this.emit('idle', ...args);
- });
- }
- /**
- * Optional methods passed to the underlying transport object
- */
- ['close', 'isIdle', 'verify'].forEach(method => {
- this[method] = (...args) => {
- if (typeof this.transporter[method] === 'function') {
- return this.transporter[method](...args);
- } else {
- this.logger.warn(
- {
- tnx: 'transport',
- methodName: method
- },
- 'Non existing method %s called for transport',
- method
- );
- return false;
- }
- };
- });
- // setup proxy handling
- if (this.options.proxy && typeof this.options.proxy === 'string') {
- this.setupProxy(this.options.proxy);
- }
- }
- use(step, plugin) {
- step = (step || '').toString();
- if (!this._userPlugins.hasOwnProperty(step)) {
- this._userPlugins[step] = [plugin];
- } else {
- this._userPlugins[step].push(plugin);
- }
- return this;
- }
- /**
- * Sends an email using the preselected transport object
- *
- * @param {Object} data E-data description
- * @param {Function?} callback Callback to run once the sending succeeded or failed
- */
- sendMail(data, callback) {
- let promise;
- if (!callback) {
- promise = new Promise((resolve, reject) => {
- callback = shared.callbackPromise(resolve, reject);
- });
- }
- if (typeof this.getSocket === 'function') {
- this.transporter.getSocket = this.getSocket;
- this.getSocket = false;
- }
- let mail = new MailMessage(this, data);
- this.logger.debug(
- {
- tnx: 'transport',
- name: this.transporter.name,
- version: this.transporter.version,
- action: 'send'
- },
- 'Sending mail using %s/%s',
- this.transporter.name,
- this.transporter.version
- );
- this._processPlugins('compile', mail, err => {
- if (err) {
- this.logger.error(
- {
- err,
- tnx: 'plugin',
- action: 'compile'
- },
- 'PluginCompile Error: %s',
- err.message
- );
- return callback(err);
- }
- mail.message = new MailComposer(mail.data).compile();
- mail.setMailerHeader();
- mail.setPriorityHeaders();
- mail.setListHeaders();
- this._processPlugins('stream', mail, err => {
- if (err) {
- this.logger.error(
- {
- err,
- tnx: 'plugin',
- action: 'stream'
- },
- 'PluginStream Error: %s',
- err.message
- );
- return callback(err);
- }
- if (mail.data.dkim || this.dkim) {
- mail.message.processFunc(input => {
- let dkim = mail.data.dkim ? new DKIM(mail.data.dkim) : this.dkim;
- this.logger.debug(
- {
- tnx: 'DKIM',
- messageId: mail.message.messageId(),
- dkimDomains: dkim.keys.map(key => key.keySelector + '.' + key.domainName).join(', ')
- },
- 'Signing outgoing message with %s keys',
- dkim.keys.length
- );
- return dkim.sign(input, mail.data._dkim);
- });
- }
- this.transporter.send(mail, (...args) => {
- if (args[0]) {
- this.logger.error(
- {
- err: args[0],
- tnx: 'transport',
- action: 'send'
- },
- 'Send Error: %s',
- args[0].message
- );
- }
- callback(...args);
- });
- });
- });
- return promise;
- }
- getVersionString() {
- return util.format('%s (%s; +%s; %s/%s)', packageData.name, packageData.version, packageData.homepage, this.transporter.name, this.transporter.version);
- }
- _processPlugins(step, mail, callback) {
- step = (step || '').toString();
- if (!this._userPlugins.hasOwnProperty(step)) {
- return callback();
- }
- let userPlugins = this._userPlugins[step] || [];
- let defaultPlugins = this._defaultPlugins[step] || [];
- if (userPlugins.length) {
- this.logger.debug(
- {
- tnx: 'transaction',
- pluginCount: userPlugins.length,
- step
- },
- 'Using %s plugins for %s',
- userPlugins.length,
- step
- );
- }
- if (userPlugins.length + defaultPlugins.length === 0) {
- return callback();
- }
- let pos = 0;
- let block = 'default';
- let processPlugins = () => {
- let curplugins = block === 'default' ? defaultPlugins : userPlugins;
- if (pos >= curplugins.length) {
- if (block === 'default' && userPlugins.length) {
- block = 'user';
- pos = 0;
- curplugins = userPlugins;
- } else {
- return callback();
- }
- }
- let plugin = curplugins[pos++];
- plugin(mail, err => {
- if (err) {
- return callback(err);
- }
- processPlugins();
- });
- };
- processPlugins();
- }
- /**
- * Sets up proxy handler for a Nodemailer object
- *
- * @param {String} proxyUrl Proxy configuration url
- */
- setupProxy(proxyUrl) {
- let proxy = urllib.parse(proxyUrl);
- // setup socket handler for the mailer object
- this.getSocket = (options, callback) => {
- let protocol = proxy.protocol.replace(/:$/, '').toLowerCase();
- if (this.meta.has('proxy_handler_' + protocol)) {
- return this.meta.get('proxy_handler_' + protocol)(proxy, options, callback);
- }
- switch (protocol) {
- // Connect using a HTTP CONNECT method
- case 'http':
- case 'https':
- httpProxyClient(proxy.href, options.port, options.host, (err, socket) => {
- if (err) {
- return callback(err);
- }
- return callback(null, {
- connection: socket
- });
- });
- return;
- case 'socks':
- case 'socks5':
- case 'socks4':
- case 'socks4a': {
- if (!this.meta.has('proxy_socks_module')) {
- return callback(new Error('Socks module not loaded'));
- }
- let connect = ipaddress => {
- let proxyV2 = !!this.meta.get('proxy_socks_module').SocksClient;
- let socksClient = proxyV2 ? this.meta.get('proxy_socks_module').SocksClient : this.meta.get('proxy_socks_module');
- let proxyType = Number(proxy.protocol.replace(/\D/g, '')) || 5;
- let connectionOpts = {
- proxy: {
- ipaddress,
- port: Number(proxy.port),
- type: proxyType
- },
- [proxyV2 ? 'destination' : 'target']: {
- host: options.host,
- port: options.port
- },
- command: 'connect'
- };
- if (proxy.auth) {
- let username = decodeURIComponent(proxy.auth.split(':').shift());
- let password = decodeURIComponent(proxy.auth.split(':').pop());
- if (proxyV2) {
- connectionOpts.userId = username;
- connectionOpts.password = password;
- } else if (proxyType === 4) {
- connectionOpts.userid = username;
- } else {
- connectionOpts.authentication = {
- username,
- password
- };
- }
- }
- socksClient.createConnection(connectionOpts, (err, info) => {
- if (err) {
- return callback(err);
- }
- return callback(null, {
- connection: info.socket || info
- });
- });
- };
- if (net.isIP(proxy.hostname)) {
- return connect(proxy.hostname);
- }
- return dns.resolve(proxy.hostname, (err, address) => {
- if (err) {
- return callback(err);
- }
- connect(Array.isArray(address) ? address[0] : address);
- });
- }
- }
- callback(new Error('Unknown proxy configuration'));
- };
- }
- _convertDataImages(mail, callback) {
- if ((!this.options.attachDataUrls && !mail.data.attachDataUrls) || !mail.data.html) {
- return callback();
- }
- mail.resolveContent(mail.data, 'html', (err, html) => {
- if (err) {
- return callback(err);
- }
- let cidCounter = 0;
- html = (html || '').toString().replace(/(<img\b[^>]* src\s*=[\s"']*)(data:([^;]+);[^"'>\s]+)/gi, (match, prefix, dataUri, mimeType) => {
- let cid = crypto.randomBytes(10).toString('hex') + '@localhost';
- if (!mail.data.attachments) {
- mail.data.attachments = [];
- }
- if (!Array.isArray(mail.data.attachments)) {
- mail.data.attachments = [].concat(mail.data.attachments || []);
- }
- mail.data.attachments.push({
- path: dataUri,
- cid,
- filename: 'image-' + ++cidCounter + '.' + mimeTypes.detectExtension(mimeType)
- });
- return prefix + 'cid:' + cid;
- });
- mail.data.html = html;
- callback();
- });
- }
- set(key, value) {
- return this.meta.set(key, value);
- }
- get(key) {
- return this.meta.get(key);
- }
- }
- module.exports = Mail;
|