misc: added email formatting for remaining templates

misc: added email self-host conditionals
Merge pull request #2166 from Infisical/misc/updated-cf-worker-integration-doc
2025-08-28 18:55:53 +00:00 · 2024-07-24 16:33:41 +08:00 · 2024-07-24 00:55:02 +08:00 · 2024-07-23 21:16:56 +08:00 · 2024-07-23 21:03:46 +08:00 · 2024-07-23 20:40:07 +08:00
9 changed files with 29 additions and 24 deletions
--- a/backend/src/services/smtp/smtp-service.ts
+++ b/backend/src/services/smtp/smtp-service.ts
@@ -5,6 +5,7 @@ import handlebars from "handlebars";
 import { createTransport } from "nodemailer";
 import SMTPTransport from "nodemailer/lib/smtp-transport";

+import { getConfig } from "@app/lib/config/env";
 import { logger } from "@app/lib/logger";

 export type TSmtpConfig = SMTPTransport.Options;
@@ -12,7 +13,7 @@ export type TSmtpSendMail = {
  template: SmtpTemplates;
  subjectLine: string;
  recipients: string[];
-  substitutions: unknown;
+  substitutions: object;
 };
 export type TSmtpService = ReturnType<typeof smtpServiceFactory>;

@@ -47,9 +48,11 @@ export const smtpServiceFactory = (cfg: TSmtpConfig) => {
  const isSmtpOn = Boolean(cfg.host);

  const sendMail = async ({ substitutions, recipients, template, subjectLine }: TSmtpSendMail) => {
+    const appCfg = getConfig();
    const html = await fs.readFile(path.resolve(__dirname, "./templates/", template), "utf8");
    const temp = handlebars.compile(html);
-    const htmlToSend = temp(substitutions);
+    const htmlToSend = temp({ isCloud: appCfg.isCloud, siteUrl: appCfg.SITE_URL, ...substitutions });
+
    if (isSmtpOn) {
      await smtp.sendMail({
        from: cfg.from,
--- a/backend/src/services/smtp/templates/emailMfa.handlebars
+++ b/backend/src/services/smtp/templates/emailMfa.handlebars
@@ -1,19 +1,19 @@
 <!DOCTYPE html>
 <html>

-<head>
-    <meta charset="utf-8">
-    <meta http-equiv="x-ua-compatible" content="ie=edge">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="x-ua-compatible" content="ie=edge" />
    <title>MFA Code</title>
-</head>
+  </head>

-<body>
+  <body>
    <h2>Infisical</h2>
    <h2>Sign in attempt requires further verification</h2>
    <p>Your MFA code is below — enter it where you started signing in to Infisical.</p>
    <h2>{{code}}</h2>
    <p>The MFA code will be valid for 2 minutes.</p>
-    <p>Not you? Contact Infisical or your administrator immediately.</p>
-</body>
+    <p>Not you? Contact {{#if isCloud}}Infisical{{else}}your administrator{{/if}} immediately.</p>
+  </body>

 </html>
--- a/backend/src/services/smtp/templates/historicalSecretLeakIncident.handlebars
+++ b/backend/src/services/smtp/templates/historicalSecretLeakIncident.handlebars
@@ -9,12 +9,12 @@

 <body>
  <h3>Infisical has uncovered {{numberOfSecrets}} secret(s) from historical commits to your repo</h3>
-  <p><a href="https://app.infisical.com/secret-scanning"><strong>View leaked secrets</strong></a></p>
+  <p><a href="{{siteUrl}}/secret-scanning"><strong>View leaked secrets</strong></a></p>

  <p>If these are production secrets, please rotate them immediately.</p>

  <p>Once you have taken action, be sure to update the status of the risk in your <a
-      href="https://app.infisical.com/">Infisical
+      href="{{siteUrl}}">Infisical
      dashboard</a>.</p>
 </body>

--- a/backend/src/services/smtp/templates/newDevice.handlebars
+++ b/backend/src/services/smtp/templates/newDevice.handlebars
@@ -1,19 +1,19 @@
 <!DOCTYPE html>
 <html>

-<head>
-    <meta charset="utf-8">
-    <meta http-equiv="x-ua-compatible" content="ie=edge">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="x-ua-compatible" content="ie=edge" />
    <title>Successful login for {{email}} from new device</title>
-</head>
+  </head>

-<body>
+  <body>
    <h2>Infisical</h2>
    <p>We're verifying a recent login for {{email}}:</p>
    <p><strong>Timestamp</strong>: {{timestamp}}</p>
    <p><strong>IP address</strong>: {{ip}}</p>
    <p><strong>User agent</strong>: {{userAgent}}</p>
-    <p>If you believe that this login is suspicious, please contact Infisical or reset your password immediately.</p>
-</body>
+    <p>If you believe that this login is suspicious, please contact {{#if isCloud}}Infisical{{else}}your administrator{{/if}} or reset your password immediately.</p>
+  </body>

 </html>
--- a/backend/src/services/smtp/templates/passwordReset.handlebars
+++ b/backend/src/services/smtp/templates/passwordReset.handlebars
@@ -9,6 +9,6 @@
    <h2>Reset your password</h2>
    <p>Someone requested a password reset.</p>
    <a href="{{callback_url}}?token={{token}}&to={{email}}">Reset password</a>
-    <p>If you didn't initiate this request, please contact us immediately at team@infisical.com</p>
+    <p>If you didn't initiate this request, please contact {{#if isCloud}}us immediately at team@infisical.com.{{else}}your administrator immediately.{{/if}}</p>
 </body>
 </html>
--- a/backend/src/services/smtp/templates/secretLeakIncident.handlebars
+++ b/backend/src/services/smtp/templates/secretLeakIncident.handlebars
@@ -9,7 +9,7 @@

 <body>
  <h3>Infisical has uncovered {{numberOfSecrets}} secret(s) from your recent push</h3>
-  <p><a href="https://app.infisical.com/secret-scanning"><strong>View leaked secrets</strong></a></p>
+  <p><a href="{{siteUrl}}/secret-scanning"><strong>View leaked secrets</strong></a></p>
  <p>You are receiving this notification because one or more secret leaks have been detected in a recent commit pushed
    by {{pusher_name}} ({{pusher_email}}). If
    these are test secrets, please add `infisical-scan:ignore` at the end of the line containing the secret as comment
@@ -18,7 +18,7 @@
  <p>If these are production secrets, please rotate them immediately.</p>

  <p>Once you have taken action, be sure to update the status of the risk in your <a
-      href="https://app.infisical.com/">Infisical
+      href="{{siteUrl}}">Infisical
      dashboard</a>.</p>
 </body>

--- a/backend/src/services/smtp/templates/signupEmailVerification.handlebars
+++ b/backend/src/services/smtp/templates/signupEmailVerification.handlebars
@@ -11,7 +11,7 @@
    <h2>Confirm your email address</h2>
    <p>Your confirmation code is below — enter it in the browser window where you've started signing up for Infisical.</p>
    <h1>{{code}}</h1>
-    <p>Questions about setting up Infisical? Email us at support@infisical.com</p>
+    <p>Questions about setting up Infisical? {{#if isCloud}}Email us at support@infisical.com{{else}}Contact your administrator{{/if}}.</p>
 </body>

 </html>
--- a/docs/images/integrations/cloudflare/integrations-cloudflare-workers-permission.png
+++ b/docs/images/integrations/cloudflare/integrations-cloudflare-workers-permission.png
--- a/docs/integrations/cloud/cloudflare-workers.mdx
+++ b/docs/integrations/cloud/cloudflare-workers.mdx
@@ -15,7 +15,7 @@ Prerequisites:

    ![integrations cloudflare credentials 1](../../images/integrations/cloudflare/integrations-cloudflare-credentials-1.png)
    ![integrations cloudflare credentials 2](../../images/integrations/cloudflare/integrations-cloudflare-credentials-2.png)
-    ![integrations cloudflare credentials 3](../../images/integrations/cloudflare/integrations-cloudflare-credentials-3.png)
+    ![integrations cloudflare credentials 3](../../images/integrations/cloudflare/integrations-cloudflare-workers-permission.png)

    Copy your [Account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/) from Account > Workers & Pages > Overview

@@ -35,10 +35,12 @@ Prerequisites:
      breaks E2EE, it's necessary for Infisical to sync the environment variables to
      the cloud platform.
    </Info>
+
  </Step>
  <Step title="Start integration">
    Select which Infisical environment secrets you want to sync to Cloudflare Workers and press create integration to start syncing secrets.

    ![integrations cloudflare](../../images/integrations/cloudflare/integration-cloudflare-workers-create.png)
+
  </Step>
-</Steps>
+</Steps>
Author	SHA1	Message	Date
Sheen Capadngan	8e373fe9bf	misc: added email formatting for remaining templates	2024-07-24 16:33:41 +08:00
Sheen Capadngan	28087cdcc4	misc: added email self-host conditionals	2024-07-24 00:55:02 +08:00
Sheen Capadngan	02eea4d886	Merge pull request #2166 from Infisical/misc/updated-cf-worker-integration-doc misc: updated cf worker integration doc	2024-07-23 21:16:56 +08:00
Sheen Capadngan	d12144a7e7	misc: added highligting	2024-07-23 21:03:46 +08:00
Sheen Capadngan	5fa69235d1	misc: updated cf worker integration doc	2024-07-23 20:40:07 +08:00