Vulcan/packages/vulcan-email/lib/server/email.js

/* eslint-disable no-console */
import VulcanEmail from '../namespace.js';
import Juice from 'juice';
import htmlToText from 'html-to-text';
import Handlebars from 'handlebars';
import { Utils, getSetting, registerSetting, runQuery, Strings, getString } from 'meteor/vulcan:lib'; // import from vulcan:lib because vulcan:core is not loaded yet

/*

Get intl string. Usage: {{__ "posts.create"}}

*/
Handlebars.registerHelper('__', function(id, context) {
  const s = getString({ id, locale: context.data.root.locale });
  return new Handlebars.SafeString(s);
});

/*

Get intl string, accepts a second variables argument. Usage: {{__ "posts.create" postVariables}}

*/
Handlebars.registerHelper('___', function(id, variables, context) {
  const s = getString({ id, variables, locale: context.data.root.locale });
  return new Handlebars.SafeString(s);
});

registerSetting('secondaryColor', '#444444');
registerSetting('accentColor', '#DD3416');
registerSetting('title', 'My App');
registerSetting('tagline');
registerSetting('emailFooter');
registerSetting('logoUrl');
registerSetting('logoHeight');
registerSetting('logoWidth');
registerSetting('defaultEmail', 'noreply@example.com');
registerSetting('title', 'Vulcan');
registerSetting('enableDevelopmentEmails', false);

VulcanEmail.templates = {};

VulcanEmail.addTemplates = templates => {
  _.extend(VulcanEmail.templates, templates);
};

VulcanEmail.getTemplate = templateName => {
  if (!VulcanEmail.templates[templateName]) {
    throw new Error(`Couldn't find email template named  “${templateName}”`);
  }
  return Handlebars.compile(VulcanEmail.templates[templateName], { noEscape: true, strict: true });
}

VulcanEmail.buildTemplate = (htmlContent, data = {}, locale) => {
  const emailProperties = {
    secondaryColor: getSetting('secondaryColor', '#444444'),
    accentColor: getSetting('accentColor', '#DD3416'),
    siteName: getSetting('title', 'My App'),
    tagline: getSetting('tagline'),
    siteUrl: Utils.getSiteUrl(),
    body: htmlContent,
    unsubscribe: '',
    accountLink: Utils.getSiteUrl() + 'account',
    footer: getSetting('emailFooter'),
    logoUrl: getSetting('logoUrl'),
    logoHeight: getSetting('logoHeight'),
    logoWidth: getSetting('logoWidth'),
    ...data,
    __: Strings[locale],
  };

  const emailHTML = VulcanEmail.getTemplate('wrapper')(emailProperties);
  const inlinedHTML = Juice(emailHTML, { preserveMediaQueries: true });
  const doctype =
    '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">';

  return doctype + inlinedHTML;
};

VulcanEmail.generateTextVersion = html => {
  return htmlToText.fromString(html, {
    wordwrap: 130,
  });
};

VulcanEmail.send = (to, subject, html, text, throwErrors, cc, bcc, replyTo, headers) => {
  // TODO: limit who can send emails
  // TODO: fix this error: Error: getaddrinfo ENOTFOUND

  if (typeof to === 'object') {
    // eslint-disable-next-line no-redeclare
    var { to, cc, bcc, replyTo, subject, html, text, throwErrors, headers } = to;
  }

  const from = getSetting('defaultEmail', 'noreply@example.com');
  const siteName = getSetting('title', 'Vulcan');
  subject = subject || '[' + siteName + ']';

  if (typeof text === 'undefined') {
    // Auto-generate text version if it doesn't exist. Has bugs, but should be good enough.
    text = VulcanEmail.generateTextVersion(html);
  }

  const email = {
    from: from,
    to: to,
    cc: cc,
    bcc: bcc,
    replyTo: replyTo,
    subject: subject,
    headers: headers,
    text: text,
    html: html,
  };

  const shouldSendEmail = process.env.NODE_ENV === 'production' || getSetting('enableDevelopmentEmails', false)

  console.log(`//////// sending email${shouldSendEmail ? '' : ' (simulation)'}…`); // eslint-disable-line
  console.log('from: ' + from); // eslint-disable-line
  console.log('to: ' + to); // eslint-disable-line
  console.log('cc: ' + cc); // eslint-disable-line
  console.log('bcc: ' + bcc); // eslint-disable-line
  console.log('replyTo: ' + replyTo); // eslint-disable-line
  console.log('headers: ' + JSON.stringify(headers)); // eslint-disable-line

  if (shouldSendEmail) {
    try {
      Email.send(email);
    } catch (error) {
      console.log('// error while sending email:'); // eslint-disable-line
      console.log(error); // eslint-disable-line
      if (throwErrors) throw error;
    }
  }

  return email;
};

VulcanEmail.build = async ({ emailName, variables, locale }) => {
  // execute email's GraphQL query
  const email = VulcanEmail.emails[emailName];
  const result = email.query ? await runQuery(email.query, variables, { locale }) : { data: {} };

  // if email has a data() function, merge its return value with results from the query
  const data = email.data ? { ...result.data, ...email.data({ data: result.data, variables, locale }) } : result.data;

  const subject = typeof email.subject === 'function' ? email.subject({ data, variables, locale }) : email.subject;

  data.__ = Strings[locale];
  data.locale = locale;

  const html = VulcanEmail.buildTemplate(VulcanEmail.getTemplate(email.template)(data), data, locale);

  return { data, subject, html };
};

VulcanEmail.buildAndSend = async ({ to, cc, bcc, replyTo, emailName, variables, locale = getSetting('locale'), headers }) => {
  const email = await VulcanEmail.build({ to, emailName, variables, locale });
  return VulcanEmail.send({ to, cc, bcc, replyTo, subject: email.subject, html: email.html, headers });
};

VulcanEmail.buildAndSendHTML = (to, subject, html) => VulcanEmail.send(to, subject, VulcanEmail.buildTemplate(html));
Fix linting 2018-01-25 15:03:03 -06:00			`/* eslint-disable no-console */`
Nova -> Vulcan 2017-03-24 10:35:19 +09:00			`import VulcanEmail from '../namespace.js';`
refactoring emails and newsletter to get rid of some meteor packages 2016-05-20 09:59:01 +09:00			`import Juice from 'juice';`
			`import htmlToText from 'html-to-text';`
			`import Handlebars from 'handlebars';`
Change email.data() and email.subject() signatures to single object; also pass locale; add __ and ___ handlebar helpers 2018-10-20 16:41:02 +09:00			`import { Utils, getSetting, registerSetting, runQuery, Strings, getString } from 'meteor/vulcan:lib'; // import from vulcan:lib because vulcan:core is not loaded yet`

			`/*`

			`Get intl string. Usage: {{__ "posts.create"}}`

			`*/`
			`Handlebars.registerHelper('__', function(id, context) {`
			`const s = getString({ id, locale: context.data.root.locale });`
			`return new Handlebars.SafeString(s);`
			`});`

			`/*`

			`Get intl string, accepts a second variables argument. Usage: {{__ "posts.create" postVariables}}`

			`*/`
			`Handlebars.registerHelper('___', function(id, variables, context) {`
			`const s = getString({ id, variables, locale: context.data.root.locale });`
			`return new Handlebars.SafeString(s);`
			`});`
Clean up/refactor settings; add registerSetting and /settings route 2017-09-22 12:24:15 +02:00
			`registerSetting('secondaryColor', '#444444');`
			`registerSetting('accentColor', '#DD3416');`
			`registerSetting('title', 'My App');`
			`registerSetting('tagline');`
			`registerSetting('emailFooter');`
			`registerSetting('logoUrl');`
			`registerSetting('logoHeight');`
			`registerSetting('logoWidth');`
			`registerSetting('defaultEmail', 'noreply@example.com');`
			`registerSetting('title', 'Vulcan');`
			`registerSetting('enableDevelopmentEmails', false);`
refactoring emails and newsletter to get rid of some meteor packages 2016-05-20 09:59:01 +09:00
Nova -> Vulcan 2017-03-24 10:35:19 +09:00			`VulcanEmail.templates = {};`
switched from handlebars-server to spacebars-tohtml 2015-12-14 12:43:45 +09:00
Nova -> Vulcan 2017-03-24 10:35:19 +09:00			`VulcanEmail.addTemplates = templates => {`
			`_.extend(VulcanEmail.templates, templates);`
switched from handlebars-server to spacebars-tohtml 2015-12-14 12:43:45 +09:00			`};`

Better error when template doesn't exist 2018-09-29 17:12:58 +09:00			`VulcanEmail.getTemplate = templateName => {`
			`if (!VulcanEmail.templates[templateName]) {`
			throw new Error(`Couldn't find email template named “${templateName}”`);
			`}`
			`return Handlebars.compile(VulcanEmail.templates[templateName], { noEscape: true, strict: true });`
			`}`
modify custom template prefix system to accept multiple simultaneous prefixes 2015-08-03 15:42:28 +09:00
Add correct property to email data for intl Strings 2018-06-11 10:53:39 +09:00			`VulcanEmail.buildTemplate = (htmlContent, data = {}, locale) => {`
work on notifications * Telescope.notifications.create -> import { createNotifications } from 'meteor/nova:notifications' ; * leverage Meteor's weak dependencies on packages & move code related to emails / notifications from nova:posts et al. to nova:notifications 2017-02-16 10:04:00 +01:00			`const emailProperties = {`
Telescope.settings.get -> getSetting 2016-12-12 15:00:56 +09:00			`secondaryColor: getSetting('secondaryColor', '#444444'),`
			`accentColor: getSetting('accentColor', '#DD3416'),`
Nova -> Vulcan 2017-03-24 10:35:19 +09:00			`siteName: getSetting('title', 'My App'),`
Telescope.settings.get -> getSetting 2016-12-12 15:00:56 +09:00			`tagline: getSetting('tagline'),`
Telescope.utils -> Utils 2016-12-12 11:34:28 +09:00			`siteUrl: Utils.getSiteUrl(),`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00			`body: htmlContent,`
			`unsubscribe: '',`
ESLint fixes 2018-09-16 11:48:38 +09:00			`accountLink: Utils.getSiteUrl() + 'account',`
Telescope.settings.get -> getSetting 2016-12-12 15:00:56 +09:00			`footer: getSetting('emailFooter'),`
			`logoUrl: getSetting('logoUrl'),`
			`logoHeight: getSetting('logoHeight'),`
			`logoWidth: getSetting('logoWidth'),`
Add correct property to email data for intl Strings 2018-06-11 10:53:39 +09:00			`...data,`
			`__: Strings[locale],`
Improve jsHint consistency This commit touch a lot of lines of code with the goal to be more rigorous about JavaScript code conventions defined in the `.jshintrc`. Some modification: * Add a list of used global symbols in the corresponding section of `.jshintrc` * Use local variables instead of global in a lot of places where the keyword `var` was mistakenly forgotten * Add missing semi-colons after instructions * Add new lines at the end of files * Remove trailing whitespaces * Use newer name of some Meteor APIs, eg `addFiles` instead of `add_files` * Add missing `break` statements in `switch` blocks * Use `===` instead of `==` and `!==` instead of `!=` * Remove unused variables This commit should also fix a few bugs due to this lack of rigor. One example of that was the test `typeof navElements === "array"` that was never true because in JavaScript, `typeof [] === "object"`, we replaced this test by the `_.isArray` method provided by underscore. It might also fix some potential collision related to global variables. There is still plenty of work until Telescope code base passes jsHint validation, but at least this commit is a step in the right direction. 2015-05-01 18:22:00 +02:00			`};`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00
Fix ESLint 2018-09-12 11:59:00 +09:00			`const emailHTML = VulcanEmail.getTemplate('wrapper')(emailProperties);`
ESLint fixes 2018-09-16 11:48:38 +09:00			`const inlinedHTML = Juice(emailHTML, { preserveMediaQueries: true });`
			`const doctype =`
			`'<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">';`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00
ESLint fixes 2018-09-16 11:48:38 +09:00			`return doctype + inlinedHTML;`
Improve jsHint consistency This commit touch a lot of lines of code with the goal to be more rigorous about JavaScript code conventions defined in the `.jshintrc`. Some modification: * Add a list of used global symbols in the corresponding section of `.jshintrc` * Use local variables instead of global in a lot of places where the keyword `var` was mistakenly forgotten * Add missing semi-colons after instructions * Add new lines at the end of files * Remove trailing whitespaces * Use newer name of some Meteor APIs, eg `addFiles` instead of `add_files` * Add missing `break` statements in `switch` blocks * Use `===` instead of `==` and `!==` instead of `!=` * Remove unused variables This commit should also fix a few bugs due to this lack of rigor. One example of that was the test `typeof navElements === "array"` that was never true because in JavaScript, `typeof [] === "object"`, we replaced this test by the `_.isArray` method provided by underscore. It might also fix some potential collision related to global variables. There is still plenty of work until Telescope code base passes jsHint validation, but at least this commit is a step in the right direction. 2015-05-01 18:22:00 +02:00			`};`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00
refactor vulcan:newsletter package to be collection-agnostic; move posts newsletter logic to posts package 2017-08-28 22:27:07 +09:00			`VulcanEmail.generateTextVersion = html => {`
			`return htmlToText.fromString(html, {`
ESLint fixes 2018-09-16 11:48:38 +09:00			`wordwrap: 130,`
refactor vulcan:newsletter package to be collection-agnostic; move posts newsletter logic to posts package 2017-08-28 22:27:07 +09:00			`});`
ESLint fixes 2018-09-16 11:48:38 +09:00			`};`
refactor vulcan:newsletter package to be collection-agnostic; move posts newsletter logic to posts package 2017-08-28 22:27:07 +09:00
Support email headers property 2018-09-26 12:24:48 -07:00			`VulcanEmail.send = (to, subject, html, text, throwErrors, cc, bcc, replyTo, headers) => {`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00			`// TODO: limit who can send emails`
			`// TODO: fix this error: Error: getaddrinfo ENOTFOUND`
ESLint fixes 2018-09-16 11:48:38 +09:00
			`if (typeof to === 'object') {`
			`// eslint-disable-next-line no-redeclare`
Support email headers property 2018-09-26 12:24:48 -07:00			`var { to, cc, bcc, replyTo, subject, html, text, throwErrors, headers } = to;`
refactored again and eliminated utils helpers 2018-09-14 12:36:19 +02:00			`}`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00
work on notifications * Telescope.notifications.create -> import { createNotifications } from 'meteor/nova:notifications' ; * leverage Meteor's weak dependencies on packages & move code related to emails / notifications from nova:posts et al. to nova:notifications 2017-02-16 10:04:00 +01:00			`const from = getSetting('defaultEmail', 'noreply@example.com');`
Add “enableDevelopmentEmails” setting that defaults to false to prevent sending unwanted dev emails 2017-05-23 09:44:22 +09:00			`const siteName = getSetting('title', 'Vulcan');`
Email subjects shouldn't be coupled with sitename 2018-09-27 03:24:11 -07:00			`subject = subject \|\| '[' + siteName + ']';`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00
ESLint fixes 2018-09-16 11:48:38 +09:00			`if (typeof text === 'undefined') {`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00			`// Auto-generate text version if it doesn't exist. Has bugs, but should be good enough.`
refactor vulcan:newsletter package to be collection-agnostic; move posts newsletter logic to posts package 2017-08-28 22:27:07 +09:00			`text = VulcanEmail.generateTextVersion(html);`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00			`}`

work on notifications * Telescope.notifications.create -> import { createNotifications } from 'meteor/nova:notifications' ; * leverage Meteor's weak dependencies on packages & move code related to emails / notifications from nova:posts et al. to nova:notifications 2017-02-16 10:04:00 +01:00			`const email = {`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00			`from: from,`
			`to: to,`
added support for cc, bcc, and replyTo fields for email API 2018-09-10 21:13:50 +02:00			`cc: cc,`
			`bcc: bcc,`
			`replyTo: replyTo,`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00			`subject: subject,`
Support email headers property 2018-09-26 12:24:48 -07:00			`headers: headers,`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00			`text: text,`
ESLint fixes 2018-09-16 11:48:38 +09:00			`html: html,`
Improve jsHint consistency This commit touch a lot of lines of code with the goal to be more rigorous about JavaScript code conventions defined in the `.jshintrc`. Some modification: * Add a list of used global symbols in the corresponding section of `.jshintrc` * Use local variables instead of global in a lot of places where the keyword `var` was mistakenly forgotten * Add missing semi-colons after instructions * Add new lines at the end of files * Remove trailing whitespaces * Use newer name of some Meteor APIs, eg `addFiles` instead of `add_files` * Add missing `break` statements in `switch` blocks * Use `===` instead of `==` and `!==` instead of `!=` * Remove unused variables This commit should also fix a few bugs due to this lack of rigor. One example of that was the test `typeof navElements === "array"` that was never true because in JavaScript, `typeof [] === "object"`, we replaced this test by the `_.isArray` method provided by underscore. It might also fix some potential collision related to global variables. There is still plenty of work until Telescope code base passes jsHint validation, but at least this commit is a step in the right direction. 2015-05-01 18:22:00 +02:00			`};`
Add “enableDevelopmentEmails” setting that defaults to false to prevent sending unwanted dev emails 2017-05-23 09:44:22 +09:00
simplify email logic 2018-09-26 12:41:02 -07:00			`const shouldSendEmail = process.env.NODE_ENV === 'production' \|\| getSetting('enableDevelopmentEmails', false)`
Add “enableDevelopmentEmails” setting that defaults to false to prevent sending unwanted dev emails 2017-05-23 09:44:22 +09:00
simplify email logic 2018-09-26 12:41:02 -07:00			console.log(`//////// sending email${shouldSendEmail ? '' : ' (simulation)'}…`); // eslint-disable-line
			`console.log('from: ' + from); // eslint-disable-line`
Various small fixes 2018-10-14 18:10:32 +09:00			`console.log('to: ' + to); // eslint-disable-line`
simplify email logic 2018-09-26 12:41:02 -07:00			`console.log('cc: ' + cc); // eslint-disable-line`
			`console.log('bcc: ' + bcc); // eslint-disable-line`
			`console.log('replyTo: ' + replyTo); // eslint-disable-line`
			`console.log('headers: ' + JSON.stringify(headers)); // eslint-disable-line`

			`if (shouldSendEmail) {`
Add “enableDevelopmentEmails” setting that defaults to false to prevent sending unwanted dev emails 2017-05-23 09:44:22 +09:00			`try {`
			`Email.send(email);`
			`} catch (error) {`
ESLint fixes 2018-09-16 11:48:38 +09:00			`console.log('// error while sending email:'); // eslint-disable-line`
Add “enableDevelopmentEmails” setting that defaults to false to prevent sending unwanted dev emails 2017-05-23 09:44:22 +09:00			`console.log(error); // eslint-disable-line`
- Correct Callbacks schema to ensure compatibility with more recent versions of simpl-schema - Add option to VulcanEmail.send to not swallow errors - Only use md5 module of crypto-js to reduce bundle size 2018-02-16 01:00:33 -05:00			`if (throwErrors) throw error;`
Add “enableDevelopmentEmails” setting that defaults to false to prevent sending unwanted dev emails 2017-05-23 09:44:22 +09:00			`}`
limit commenter avatars to 4; add try…catch to email sending 2016-08-26 10:16:01 +09:00			`}`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00
			`return email;`
			`};`

Add Strings object to email data, add locale support to emails 2018-05-10 09:22:24 +09:00			`VulcanEmail.build = async ({ emailName, variables, locale }) => {`
add support for passing arbitrary non-GraphQL data to email template 2017-08-20 17:15:40 +09:00			`// execute email's GraphQL query`
clean up notifications/email code 2017-08-24 13:16:50 +09:00			`const email = VulcanEmail.emails[emailName];`
ESLint fixes 2018-09-16 11:48:38 +09:00			`const result = email.query ? await runQuery(email.query, variables, { locale }) : { data: {} };`
add support for passing arbitrary non-GraphQL data to email template 2017-08-20 17:15:40 +09:00
			`// if email has a data() function, merge its return value with results from the query`
Change email.data() and email.subject() signatures to single object; also pass locale; add __ and ___ handlebar helpers 2018-10-20 16:41:02 +09:00			`const data = email.data ? { ...result.data, ...email.data({ data: result.data, variables, locale }) } : result.data;`
refactor vulcan:newsletter package to be collection-agnostic; move posts newsletter logic to posts package 2017-08-28 22:27:07 +09:00
Change email.data() and email.subject() signatures to single object; also pass locale; add __ and ___ handlebar helpers 2018-10-20 16:41:02 +09:00			`const subject = typeof email.subject === 'function' ? email.subject({ data, variables, locale }) : email.subject;`
Add Strings object to email data, add locale support to emails 2018-05-10 09:22:24 +09:00
Add correct property to email data for intl Strings 2018-06-11 10:53:39 +09:00			`data.__ = Strings[locale];`
Change email.data() and email.subject() signatures to single object; also pass locale; add __ and ___ handlebar helpers 2018-10-20 16:41:02 +09:00			`data.locale = locale;`
Add Strings object to email data, add locale support to emails 2018-05-10 09:22:24 +09:00
			`const html = VulcanEmail.buildTemplate(VulcanEmail.getTemplate(email.template)(data), data, locale);`
refactor vulcan:newsletter package to be collection-agnostic; move posts newsletter logic to posts package 2017-08-28 22:27:07 +09:00
			`return { data, subject, html };`
ESLint fixes 2018-09-16 11:48:38 +09:00			`};`
Make emails work with runQuery utility 2017-08-19 16:13:59 +09:00
Support email headers property 2018-09-26 12:24:48 -07:00			`VulcanEmail.buildAndSend = async ({ to, cc, bcc, replyTo, emailName, variables, locale = getSetting('locale'), headers }) => {`
Add Strings object to email data, add locale support to emails 2018-05-10 09:22:24 +09:00			`const email = await VulcanEmail.build({ to, emailName, variables, locale });`
Support email headers property 2018-09-26 12:24:48 -07:00			`return VulcanEmail.send({ to, cc, bcc, replyTo, subject: email.subject, html: email.html, headers });`
Improve jsHint consistency This commit touch a lot of lines of code with the goal to be more rigorous about JavaScript code conventions defined in the `.jshintrc`. Some modification: * Add a list of used global symbols in the corresponding section of `.jshintrc` * Use local variables instead of global in a lot of places where the keyword `var` was mistakenly forgotten * Add missing semi-colons after instructions * Add new lines at the end of files * Remove trailing whitespaces * Use newer name of some Meteor APIs, eg `addFiles` instead of `add_files` * Add missing `break` statements in `switch` blocks * Use `===` instead of `==` and `!==` instead of `!=` * Remove unused variables This commit should also fix a few bugs due to this lack of rigor. One example of that was the test `typeof navElements === "array"` that was never true because in JavaScript, `typeof [] === "object"`, we replaced this test by the `_.isArray` method provided by underscore. It might also fix some potential collision related to global variables. There is still plenty of work until Telescope code base passes jsHint validation, but at least this commit is a step in the right direction. 2015-05-01 18:22:00 +02:00			`};`
bringing packages back into core repo after all 2015-04-22 07:50:11 +09:00
VulcanEmail.send is backwards compatible 2018-09-13 16:41:47 +02:00			`VulcanEmail.buildAndSendHTML = (to, subject, html) => VulcanEmail.send(to, subject, VulcanEmail.buildTemplate(html));`