feat: React Emails > default template #3194

JanCizmar · 2025-08-08T07:32:14Z

No description provided.

coderabbitai · 2025-08-08T07:32:21Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch jancizmar/react-email-default-template

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

cyyynthia · 2025-08-08T09:09:01Z

backend/data/src/main/kotlin/io/tolgee/email/EmailGlobalVariablesProvider.kt

      "isCloud" to isCloud,
      "instanceQualifier" to if (isCloud) tolgeeProperties.appName else tolgeeProperties.frontEndUrl.intoQualifier(),
-      "instanceUrl" to tolgeeProperties.frontEndUrl,
+      "instanceUrl" to "http://localhost:8080",


Seeing that it makes me wonder if the issues you were experiencing are that in development the frontEndUrl points to the Vite server and it isn't configured to proxy /static/* to the backend... That'd explain it

email/components/Var.ts

cyyynthia

Leaving some feedback for consideration 😄

cyyynthia · 2025-08-19T07:28:55Z

backend/data/src/main/kotlin/io/tolgee/component/email/TolgeeEmailSender.kt

+    emailService.sendEmailTemplate(
+      recipient = params.to,
+      subject = params.subject,
+      template = params.templateName ?: "default",


FWIW, I recon my original idea was to eventually deprecate that component; i.e. new code would use the new email system while legacy code can still use this until it is eventually migrated to use a dedicated template. Not sure templateName is needed 😅

We agreed to wrap all existing emails in a default template and just drop the legacy email text into it. Since the new email designs aren’t ready yet, this lets us still use the feature in the meantime 😀

cyyynthia · 2025-08-19T07:31:52Z

backend/data/src/main/kotlin/io/tolgee/email/EmailGlobalVariablesProvider.kt

-      "instanceQualifier" to if (isCloud) tolgeeProperties.appName else tolgeeProperties.frontEndUrl.intoQualifier(),
-      "instanceUrl" to tolgeeProperties.frontEndUrl,
+      "instanceQualifier" to if (isCloud) tolgeeProperties.appName else backendUrl.intoQualifier(),
+      "backendUrl" to backendUrl


Unsure about that... Especially wrt the instance qualifier. The fallback to using the domain name people are using to access Tolgee is likely a lot more recognizable than whatever internal URL is used.

Problems in development environment are likely related to the fact I completely overlooked that and didn't add the appropriate proxy config to Vite 😅

cyyynthia · 2025-08-19T07:37:31Z

backend/data/src/main/kotlin/io/tolgee/email/EmailService.kt


    val html = templateEngine.process(template, context)
-    val subject = extractEmailTitle(html)
+    val subject = subject ?: extractEmailTitle(html)


Note: Setting a subject would break internationalization of emails. I guess this is needed for the backcompat layer, but... not ideal as it makes the service contract loose here :(

I don't think the template allows the subject being a variable directly but that could be mitigated with a passthrough i18n string; i.e. email.legacy.subject-passthrough = "{subject}"

cyyynthia · 2025-08-19T07:43:14Z

email/emails/registration-confirm.tsx

+              defaultValue="Welcome and thank you for creating an account!"
+            />{' '}
+          </If.Then>
+          <If.Else></If.Else>


Nit: If.Else isn't strictly mandatory; looking back at the HACKING.md note I see where it comes from but I more or less wanted to express that bare JSX as children of If isn't great because it's hard to tell what part of an if-then-else we're working with.

Empty else doesn't hurt, but omitting it is fine imho.

i am afraid the reason i put it there is, that it actually didn't work without <If.Else></If.Else> 🤷‍♂️ (I guess <If.Else /> shoud be good too) .. I don't know why, I was too lazy to find out 😁

btw this template is not used anyway, so it might be deleted

I initially included it as a showcase/"real-world" demo (and was the template I used while prototyping back then); but it can indeed be ditched 😅

Weird that the Else branch is required; I know for sure it didn't use to be but I might've enforced it when refactoring at some point. Not very important anyway... :)

cyyynthia · 2025-08-19T07:49:55Z

email/emails/registration-confirm.tsx

        />
      </Text>
      <Text>
+        <If condition="${isSignup}">


Not sure using the same template for registration and email changes is advisable (given the advanced templating system now); subject of the email might be ambiguous and it limits the extensibility of the registration email (e.g. adding additional sections such as getting started guides and what not).

The wording of the confirm-email-text is a bit confusing too; people aren't "starting to use" Tolgee but rather "changing their email" and I think the email body should reflect that.

Related to the 1st point email change confirmation (and other important emails) should perhaps contain warnings and advise caution regarding phishing campaigns and what to do in case of suspicious activity (use MFA, change passwords, etc).

dzienisz · 2025-09-11T12:35:12Z

@dkrizan can you add screenshot of those emails before and after the change?

github-actions · 2025-10-12T02:06:52Z

This PR is stale because it has been open for 30 days with no activity.

JanCizmar requested a review from dkrizan August 8, 2025 07:32

cyyynthia reviewed Aug 8, 2025

View reviewed changes

cyyynthia reviewed Aug 19, 2025

View reviewed changes

dkrizan force-pushed the jancizmar/react-email-default-template branch from b96f7dd to 8f5ab03 Compare September 10, 2025 15:21

dkrizan force-pushed the cynthia/react-email branch from 954b9e4 to add5c96 Compare September 10, 2025 15:25

JanCizmar and others added 6 commits September 10, 2025 17:25

feat: Html e-mail default template

cdb4f02

feat: Html e-mail default template

f95c57e

fix: email translates & assets

dcb6fb1

chore: current emails use default layout template

95165cb

chore: BE tests fix

3042fea

chore: be tests fix

2684cd3

dkrizan force-pushed the jancizmar/react-email-default-template branch from 8f5ab03 to f2badad Compare September 10, 2025 15:26

chore: e2e tests fix

d229261

dkrizan force-pushed the jancizmar/react-email-default-template branch from f2badad to d229261 Compare September 10, 2025 15:29

chore: e2e tests fix

5c23cab

dkrizan added 2 commits September 11, 2025 15:22

chore: e2e getLatestEmail with retries

d6fb732

fix: e2e signUp test

b75ec69

github-actions bot added the stale label Oct 12, 2025

JanCizmar closed this Oct 12, 2025

dkrizan reopened this Oct 13, 2025

dkrizan mentioned this pull request Oct 13, 2025

chore: html emails infrastructure #1987

Open

Uh oh!

feat: React Emails > default template #3194

Are you sure you want to change the base?

feat: React Emails > default template #3194

Uh oh!

Conversation

JanCizmar commented Aug 8, 2025

Uh oh!

coderabbitai bot commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cyyynthia left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dkrizan Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dzienisz commented Sep 11, 2025

Uh oh!

github-actions bot commented Oct 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coderabbitai bot commented Aug 8, 2025 •

edited

Loading

dkrizan Aug 19, 2025 •

edited

Loading