fix(templates): Allow setting brand name to replace 'EmailEngine' in …

…the HTML title
postalsys · Dec 30, 2024 · bf85c06 · bf85c06
1 parent b2c0c5a
commit bf85c06
Show file tree

Hide file tree

Showing 10 changed files with 36 additions and 11 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -12,7 +12,7 @@ module.exports = function (grunt) {
         wait: {
             server: {
                 options: {
-                    delay: 6 * 1000
+                    delay: 12 * 1000
                 }
             }
         },

diff --git a/lib/routes-ui.js b/lib/routes-ui.js
@@ -1234,6 +1234,7 @@ function applyRoutes(server, call) {
 
                 imapIndexer: (await settings.get('imapIndexer')) || 'full',
 
+                pageBrandName: (await settings.get('pageBrandName')) || '',
                 templateHeader: (await settings.get('templateHeader')) || '',
                 templateHtmlHead: (await settings.get('templateHtmlHead')) || '',
                 scriptEnv: (await settings.get('scriptEnv')) || '',
@@ -1305,6 +1306,7 @@ function applyRoutes(server, call) {
                 let data = {
                     serviceSecret: request.payload.serviceSecret,
                     queueKeep: request.payload.queueKeep,
+                    pageBrandName: request.payload.pageBrandName,
                     templateHeader: request.payload.templateHeader,
                     templateHtmlHead: request.payload.templateHtmlHead,
                     scriptEnv: request.payload.scriptEnv,
@@ -1429,6 +1431,7 @@ function applyRoutes(server, call) {
                     queueKeep: settingsSchema.queueKeep.default(0),
                     deliveryAttempts: settingsSchema.deliveryAttempts.default(DEFAULT_DELIVERY_ATTEMPTS),
                     imapIndexer: settingsSchema.imapIndexer.default('full'),
+                    pageBrandName: settingsSchema.pageBrandName.default(''),
                     templateHeader: settingsSchema.templateHeader.default(''),
                     templateHtmlHead: settingsSchema.templateHtmlHead.default(''),
                     scriptEnv: settingsSchema.scriptEnv.default(''),
@@ -1844,6 +1847,7 @@ return true;`
             return h.view(
                 'config/service-preview',
                 {
+                    pageBrandName: request.payload.pageBrandName,
                     embeddedTemplateHeader: request.payload.templateHeader,
                     embeddedTemplateHtmlHeadr: request.payload.templateHtmlHead
                 },
@@ -1866,6 +1870,7 @@ return true;`
                 },
 
                 payload: Joi.object({
+                    pageBrandName: settingsSchema.pageBrandName.default(''),
                     templateHeader: settingsSchema.templateHeader.default(''),
                     templateHtmlHead: settingsSchema.templateHtmlHead.default('')
                 })

diff --git a/lib/schemas.js b/lib/schemas.js
@@ -423,6 +423,8 @@ const settingsSchema = {
 
     timezone: Joi.string().max(100).example('Europe/Tallinn').description('Default timezone identifier'),
 
+    pageBrandName: Joi.string().allow('', null).max(1024).example('EmailEngine').description('Brand name to use in the HTML title element'),
+
     openAiPreProcessingFn: Joi.string()
         .allow('')
         .max(512 * 1024)

diff --git a/static/index.html b/static/index.html
@@ -3,7 +3,7 @@
     <head>
         <meta charset="utf-8" />
         <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
-        <meta name="description" content="EmailEngine Homepage" />
+        <meta name="description" content="EmailEngine Application page; The Ultimate Email API for Developers" />
         <title>EmailEngine</title>
 
         <link rel="apple-touch-icon" href="/static/favicon/apple-touch-icon.png" sizes="180x180" />

diff --git a/views/config/service.hbs b/views/config/service.hbs
@@ -343,6 +343,21 @@
             <p>These settings apply to all publicly accessible pages, such as 404 error pages, the hosted authentication
                 form, and the virtual mailing list unsubscribe page.</p>
 
+            <div class="form-group">
+                <div class="text-muted float-right code-link">[<a href="/admin/swagger#/Settings/postV1Settings"
+                        target="_blank" rel="noopener noreferrer">pageBrandName</a>]</div>
+
+                <label for="settingsPageBrandName">Brand name</label>
+                <input type="text" class="form-control {{#if errors.pageBrandName}}is-invalid{{/if}}"
+                    id="settingsPageBrandName" name="pageBrandName" value="{{values.pageBrandName}}"
+                    data-lpignore="true" autocomplete="off" placeholder="Brand name like &quot;EmailEngine&quot;" />
+                {{#if errors.pageBrandName}}
+                <span class="invalid-feedback">{{errors.pageBrandName}}</span>
+                {{/if}}
+                <small class="form-text text-muted">Brand name to use in the HTML title element (defaults to
+                    <em>"EmailEngine"</em>)</small>
+            </div>
+
             <div class="form-group">
 
                 <div class="text-muted float-right code-link">[<a href="/admin/swagger#/Settings/postV1Settings"

diff --git a/views/layout/app.hbs b/views/layout/app.hbs
@@ -6,10 +6,10 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-    <meta name="description" content="EmailEngine Homepage" />
+    <meta name="description" content="EmailEngine Application page; The Ultimate Email API for Developers" />
     <meta name="author" content="Postal Systems OÜ">
 
-    <title>{{#if pageTitleFull}}{{pageTitleFull}}{{else}}EmailEngine{{#if pageTitle}} &ndash;
+    <title>{{#if pageTitleFull}}{{pageTitleFull}}{{else}}{{pageBrandName}}{{#if pageTitle}} &ndash;
         {{pageTitle}}{{/if}}{{/if}}</title>
 
     <link rel="apple-touch-icon" href="/static/favicon/apple-touch-icon.png" sizes="180x180" />

diff --git a/views/layout/login.hbs b/views/layout/login.hbs
@@ -6,10 +6,10 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-    <meta name="description" content="EmailEngine Homepage" />
+    <meta name="description" content="EmailEngine Application page; The Ultimate Email API for Developers" />
     <meta name="author" content="Postal Systems OÜ">
 
-    <title>{{#if pageTitleFull}}{{pageTitleFull}}{{else}}EmailEngine{{#if pageTitle}} &ndash;
+    <title>{{#if pageTitleFull}}{{pageTitleFull}}{{else}}{{pageBrandName}}{{#if pageTitle}} &ndash;
         {{pageTitle}}{{/if}}{{/if}}</title>
 
     <link rel="apple-touch-icon" href="/static/favicon/apple-touch-icon.png" sizes="180x180" />

diff --git a/views/layout/main.hbs b/views/layout/main.hbs
@@ -4,7 +4,7 @@
 <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
-    <meta name="description" content="EmailEngine Homepage" />
+    <meta name="description" content="EmailEngine Application page; The Ultimate Email API for Developers" />
     <title>EmailEngine</title>
 
     <link rel="apple-touch-icon" href="/static/favicon/apple-touch-icon.png" sizes="180x180" />

diff --git a/views/layout/public.hbs b/views/layout/public.hbs
@@ -6,10 +6,10 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-    <meta name="description" content="EmailEngine Homepage" />
+    <meta name="description" content="EmailEngine Application page; The Ultimate Email API for Developers" />
     <meta name="author" content="Postal Systems OÜ">
 
-    <title>{{#if pageTitleFull}}{{pageTitleFull}}{{else}}EmailEngine{{#if pageTitle}} &ndash;
+    <title>{{#if pageTitleFull}}{{pageTitleFull}}{{else}}{{pageBrandName}}{{#if pageTitle}} &ndash;
         {{pageTitle}}{{/if}}{{/if}}</title>
 
     <link rel="apple-touch-icon" href="/static/favicon/apple-touch-icon.png" sizes="180x180" />

diff --git a/workers/api.js b/workers/api.js
@@ -8453,7 +8453,8 @@ ${now}`,
                 serviceUrl,
                 language,
                 locale,
-                timezone
+                timezone,
+                pageBrandName
             } = await settings.getMulti(
                 'upgrade',
                 'subexp',
@@ -8470,7 +8471,8 @@ ${now}`,
                 'serviceUrl',
                 'language',
                 'locale',
-                'timezone'
+                'timezone',
+                'pageBrandName'
             );
 
             const systemAlerts = [];
@@ -8614,6 +8616,7 @@ ${now}`,
             }
 
             return {
+                pageBrandName: pageBrandName || 'EmailEngine',
                 values: request.payload || {},
                 errors: (request.error && request.error.details) || {},
                 pendingMessages,