mirror of
https://github.com/fleetdm/fleet
synced 2026-05-18 14:38:53 +00:00
* add to-html-email * email-preview * add build-html-email script, update .gitignore * email preview and email-templates pages, update routes, importer and policies * add newsletter email layout, build-html-email script, to-html-email updates * Update .gitignore * add newsletter emails section to growth handbook * update scripts * update fonts in emails * Update README.md * Update build-html-email.js * update comments, add page scripts to layouts * revert change to build-static-content * update script * update email layout and helper * update handbook entry * update template data and helper * update email layout * update fake data and unsubscribe link * move added handbook section to the marketing handbook * rename script * update colors in unused email template * update capitalization in helper * view-email-preview » view-email-template-preview * Hide emails generated from markdown if they don't exist * update preview page * update markdown email directory, create sample article email * lint fixes, add target="_blank" to links in emails * update page layouts & styles * update sample newsletter email, code font, newsletter layout * Update README.md * Update view-email-template-preview.js Co-authored-by: Tim Kern <[email protected]> Co-authored-by: Mike Thomas <[email protected]> Co-authored-by: Mike McNeil <[email protected]>
133 lines
3.7 KiB
JavaScript
Vendored
133 lines
3.7 KiB
JavaScript
Vendored
module.exports = {
|
|
|
|
|
|
friendlyName: 'View email template preview',
|
|
|
|
|
|
description: 'Display "email template preview" page.',
|
|
|
|
|
|
urlWildcardSuffix: 'template',
|
|
|
|
|
|
inputs: {
|
|
|
|
template: {
|
|
description: 'The path to an email template, specified in precisely the same way as the equivalent input of the sendTemplateEmail() helper.',
|
|
example: 'email-reset-password',
|
|
type: 'string',
|
|
required: true
|
|
},
|
|
|
|
raw: {
|
|
description: 'Whether to return the raw HTML for the email with no JS/CSS (rather than a personalized previewer web page.)',
|
|
extendedDescription: 'This can be used from an iframe to allow for accurately previewing email templates without worrying about style interference from the rest of the Sails app.',
|
|
type: 'boolean',
|
|
}
|
|
|
|
},
|
|
|
|
exits: {
|
|
|
|
success: {
|
|
viewTemplatePath: 'pages/admin/email-preview'
|
|
},
|
|
|
|
sendRawHtmlInstead: {
|
|
statusCode: 200,
|
|
outputType: 'string',
|
|
outputDescription: 'The raw HTML for the email as a string.',
|
|
},
|
|
|
|
},
|
|
|
|
|
|
fn: async function ({template, raw}) {
|
|
|
|
var path = require('path');
|
|
var url = require('url');
|
|
var util = require('util');
|
|
// Determine appropriate email layout and fake data to use.
|
|
let layout;
|
|
let fakeData;
|
|
switch (template) {
|
|
case 'internal/email-contact-form':
|
|
layout = false;
|
|
fakeData = {
|
|
contactName: 'Sage',
|
|
contactEmail: '[email protected]',
|
|
topic: 'Pricing question',
|
|
message: 'What is the difference between the "Free" plan and the "Premium" plan?',
|
|
};
|
|
break;
|
|
case 'email-reset-password':
|
|
layout = 'layout-email';
|
|
fakeData = {
|
|
token: '4-32fad81jdaf$329',
|
|
};
|
|
break;
|
|
case 'email-verify-account':
|
|
layout = 'layout-email';
|
|
fakeData = {
|
|
firstName: 'Fleet user',
|
|
token: '4-32fad81jdaf$329',
|
|
};
|
|
break;
|
|
case 'email-verify-new-email':
|
|
layout = 'layout-email';
|
|
fakeData = {
|
|
fullName: 'Fleet user',
|
|
token: '4-32fad81jdaf$329',
|
|
};
|
|
break;
|
|
case 'email-order-confirmation':
|
|
layout = 'layout-email';
|
|
fakeData = {
|
|
firstName: 'Fleet',
|
|
lastName: 'user',
|
|
};
|
|
break;
|
|
default:
|
|
layout = 'layout-email-newsletter';
|
|
fakeData = {
|
|
emailAddress: '[email protected]',
|
|
};
|
|
}
|
|
|
|
// Compile HTML template using the appropriate layout.
|
|
// > Note that we set the layout, provide access to core `url` package (for
|
|
// > building links and image srcs, etc.), and also provide access to core
|
|
// > `util` package (for dumping debug data in internal emails).
|
|
let emailTemplatePath = path.join('emails/', template);
|
|
if (layout) {
|
|
layout = path.relative(path.dirname(emailTemplatePath), path.resolve('layouts/', layout));
|
|
} else {
|
|
layout = false;
|
|
}
|
|
|
|
let sampleHtml = await sails.renderView(
|
|
emailTemplatePath,
|
|
Object.assign({layout, url, util, _ }, fakeData)
|
|
)
|
|
.intercept((err)=>{
|
|
err.message = 'Whoops, that email template failed to render. Could there be some fake data missing for this particular template in the `switch` statement api/controllers/admin/view-email-template-preview.js? Any chance you need to re-lift the app after making backend changes?\nMore details: '+err.message;
|
|
return err;
|
|
});
|
|
|
|
if (raw) {
|
|
// Respond with raw, rendered HTML for this email:
|
|
throw {sendRawHtmlInstead: sampleHtml};
|
|
} else {
|
|
// Respond with the previewer page for this email:
|
|
return {
|
|
sampleHtml,
|
|
template,
|
|
fakeData,
|
|
};
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
};
|