feat: Custom message files (#1992)

* feat: add get custom message text to admin api * feat: read custom message texts from files * feat: get languages in apis * feat: get languages in apis * feat: get languages in apis * feat: pr feedback * feat: docs * feat: merge main
2025-08-12 03:37:34 +00:00 · 2021-07-13 07:13:39 +02:00
parent 7ebf0333c3
commit 03a38fbf1c
40 changed files with 1108 additions and 245 deletions
--- a/internal/notification/types/domain_claimed.go
+++ b/internal/notification/types/domain_claimed.go
@@ -1,10 +1,11 @@
 package types

 import (
-	"html"
 	"strings"

 	"github.com/caos/zitadel/internal/config/systemdefaults"
+	"github.com/caos/zitadel/internal/domain"
+	"github.com/caos/zitadel/internal/i18n"
 	iam_model "github.com/caos/zitadel/internal/iam/model"
 	"github.com/caos/zitadel/internal/notification/templates"
 	view_model "github.com/caos/zitadel/internal/user/repository/view/model"
@@ -15,7 +16,7 @@ type DomainClaimedData struct {
 	URL string
 }

-func SendDomainClaimed(mailhtml string, text *iam_model.MessageTextView, user *view_model.NotifyUser, username string, systemDefaults systemdefaults.SystemDefaults, colors *iam_model.LabelPolicyView, apiDomain string) error {
+func SendDomainClaimed(mailhtml string, translator *i18n.Translator, user *view_model.NotifyUser, username string, systemDefaults systemdefaults.SystemDefaults, colors *iam_model.LabelPolicyView, apiDomain string) error {
 	url, err := templates.ParseTemplateText(systemDefaults.Notifications.Endpoints.DomainClaimed, &UrlData{UserID: user.ID})
 	if err != nil {
 		return err
@@ -24,17 +25,13 @@ func SendDomainClaimed(mailhtml string, text *iam_model.MessageTextView, user *v
 	args["TempUsername"] = username
 	args["Domain"] = strings.Split(user.LastEmail, "@")[1]

-	text.Greeting, err = templates.ParseTemplateText(text.Greeting, args)
-	text.Text, err = templates.ParseTemplateText(text.Text, args)
-	text.Text = html.UnescapeString(text.Text)
-
-	emailCodeData := &DomainClaimedData{
-		TemplateData: templates.GetTemplateData(apiDomain, url, text, colors),
+	domainClaimedData := &DomainClaimedData{
+		TemplateData: templates.GetTemplateData(translator, args, apiDomain, url, domain.DomainClaimedMessageType, user.PreferredLanguage, colors),
 		URL:          url,
 	}
-	template, err := templates.GetParsedTemplate(mailhtml, emailCodeData)
+	template, err := templates.GetParsedTemplate(mailhtml, domainClaimedData)
 	if err != nil {
 		return err
 	}
-	return generateEmail(user, text.Subject, template, systemDefaults.Notifications, true)
+	return generateEmail(user, domainClaimedData.Subject, template, systemDefaults.Notifications, true)
 }
--- a/internal/notification/types/email_verification_code.go
+++ b/internal/notification/types/email_verification_code.go
@@ -1,10 +1,10 @@
 package types

 import (
-	"html"
-
 	"github.com/caos/zitadel/internal/config/systemdefaults"
 	"github.com/caos/zitadel/internal/crypto"
+	"github.com/caos/zitadel/internal/domain"
+	"github.com/caos/zitadel/internal/i18n"
 	iam_model "github.com/caos/zitadel/internal/iam/model"
 	"github.com/caos/zitadel/internal/notification/templates"
 	es_model "github.com/caos/zitadel/internal/user/repository/eventsourcing/model"
@@ -16,7 +16,7 @@ type EmailVerificationCodeData struct {
 	URL string
 }

-func SendEmailVerificationCode(mailhtml string, text *iam_model.MessageTextView, user *view_model.NotifyUser, code *es_model.EmailCode, systemDefaults systemdefaults.SystemDefaults, alg crypto.EncryptionAlgorithm, colors *iam_model.LabelPolicyView, apiDomain string) error {
+func SendEmailVerificationCode(mailhtml string, translator *i18n.Translator, user *view_model.NotifyUser, code *es_model.EmailCode, systemDefaults systemdefaults.SystemDefaults, alg crypto.EncryptionAlgorithm, colors *iam_model.LabelPolicyView, apiDomain string) error {
 	codeString, err := crypto.DecryptString(code.Code, alg)
 	if err != nil {
 		return err
@@ -29,12 +29,8 @@ func SendEmailVerificationCode(mailhtml string, text *iam_model.MessageTextView,
 	var args = mapNotifyUserToArgs(user)
 	args["Code"] = codeString

-	text.Greeting, err = templates.ParseTemplateText(text.Greeting, args)
-	text.Text, err = templates.ParseTemplateText(text.Text, args)
-	text.Text = html.UnescapeString(text.Text)
-
 	emailCodeData := &EmailVerificationCodeData{
-		TemplateData: templates.GetTemplateData(apiDomain, url, text, colors),
+		TemplateData: templates.GetTemplateData(translator, args, apiDomain, url, domain.VerifyEmailMessageType, user.PreferredLanguage, colors),
 		URL:          url,
 	}

@@ -42,5 +38,5 @@ func SendEmailVerificationCode(mailhtml string, text *iam_model.MessageTextView,
 	if err != nil {
 		return err
 	}
-	return generateEmail(user, text.Subject, template, systemDefaults.Notifications, true)
+	return generateEmail(user, emailCodeData.Subject, template, systemDefaults.Notifications, true)
 }
--- a/internal/notification/types/init_code.go
+++ b/internal/notification/types/init_code.go
@@ -1,10 +1,10 @@
 package types

 import (
-	"html"
-
 	"github.com/caos/zitadel/internal/config/systemdefaults"
 	"github.com/caos/zitadel/internal/crypto"
+	"github.com/caos/zitadel/internal/domain"
+	"github.com/caos/zitadel/internal/i18n"
 	iam_model "github.com/caos/zitadel/internal/iam/model"
 	"github.com/caos/zitadel/internal/notification/templates"
 	es_model "github.com/caos/zitadel/internal/user/repository/eventsourcing/model"
@@ -22,7 +22,7 @@ type UrlData struct {
 	PasswordSet bool
 }

-func SendUserInitCode(mailhtml string, text *iam_model.MessageTextView, user *view_model.NotifyUser, code *es_model.InitUserCode, systemDefaults systemdefaults.SystemDefaults, alg crypto.EncryptionAlgorithm, colors *iam_model.LabelPolicyView, apiDomain string) error {
+func SendUserInitCode(mailhtml string, translator *i18n.Translator, user *view_model.NotifyUser, code *es_model.InitUserCode, systemDefaults systemdefaults.SystemDefaults, alg crypto.EncryptionAlgorithm, colors *iam_model.LabelPolicyView, apiDomain string) error {
 	codeString, err := crypto.DecryptString(code.Code, alg)
 	if err != nil {
 		return err
@@ -34,17 +34,13 @@ func SendUserInitCode(mailhtml string, text *iam_model.MessageTextView, user *vi
 	var args = mapNotifyUserToArgs(user)
 	args["Code"] = codeString

-	text.Greeting, err = templates.ParseTemplateText(text.Greeting, args)
-	text.Text, err = templates.ParseTemplateText(text.Text, args)
-	text.Text = html.UnescapeString(text.Text)
-
-	emailCodeData := &InitCodeEmailData{
-		TemplateData: templates.GetTemplateData(apiDomain, url, text, colors),
+	initCodeData := &InitCodeEmailData{
+		TemplateData: templates.GetTemplateData(translator, args, apiDomain, url, domain.InitCodeMessageType, user.PreferredLanguage, colors),
 		URL:          url,
 	}
-	template, err := templates.GetParsedTemplate(mailhtml, emailCodeData)
+	template, err := templates.GetParsedTemplate(mailhtml, initCodeData)
 	if err != nil {
 		return err
 	}
-	return generateEmail(user, text.Subject, template, systemDefaults.Notifications, true)
+	return generateEmail(user, initCodeData.Subject, template, systemDefaults.Notifications, true)
 }
--- a/internal/notification/types/password_code.go
+++ b/internal/notification/types/password_code.go
@@ -1,10 +1,10 @@
 package types

 import (
-	"html"
-
 	"github.com/caos/zitadel/internal/config/systemdefaults"
 	"github.com/caos/zitadel/internal/crypto"
+	"github.com/caos/zitadel/internal/domain"
+	"github.com/caos/zitadel/internal/i18n"
 	iam_model "github.com/caos/zitadel/internal/iam/model"
 	"github.com/caos/zitadel/internal/notification/templates"
 	es_model "github.com/caos/zitadel/internal/user/repository/eventsourcing/model"
@@ -18,7 +18,7 @@ type PasswordCodeData struct {
 	URL       string
 }

-func SendPasswordCode(mailhtml string, text *iam_model.MessageTextView, user *view_model.NotifyUser, code *es_model.PasswordCode, systemDefaults systemdefaults.SystemDefaults, alg crypto.EncryptionAlgorithm, colors *iam_model.LabelPolicyView, apiDomain string) error {
+func SendPasswordCode(mailhtml string, translator *i18n.Translator, user *view_model.NotifyUser, code *es_model.PasswordCode, systemDefaults systemdefaults.SystemDefaults, alg crypto.EncryptionAlgorithm, colors *iam_model.LabelPolicyView, apiDomain string) error {
 	codeString, err := crypto.DecryptString(code.Code, alg)
 	if err != nil {
 		return err
@@ -30,19 +30,15 @@ func SendPasswordCode(mailhtml string, text *iam_model.MessageTextView, user *vi
 	var args = mapNotifyUserToArgs(user)
 	args["Code"] = codeString

-	text.Greeting, err = templates.ParseTemplateText(text.Greeting, args)
-	text.Text, err = templates.ParseTemplateText(text.Text, args)
-	text.Text = html.UnescapeString(text.Text)
-
-	emailCodeData := &PasswordCodeData{
-		TemplateData: templates.GetTemplateData(apiDomain, url, text, colors),
+	passwordResetData := &PasswordCodeData{
+		TemplateData: templates.GetTemplateData(translator, args, apiDomain, url, domain.PasswordResetMessageType, user.PreferredLanguage, colors),
 		FirstName:    user.FirstName,
 		LastName:     user.LastName,
 		URL:          url,
 	}
-	template, err := templates.GetParsedTemplate(mailhtml, emailCodeData)
+	template, err := templates.GetParsedTemplate(mailhtml, passwordResetData)
 	if err != nil {
 		return err
 	}
-	return generateEmail(user, text.Subject, template, systemDefaults.Notifications, true)
+	return generateEmail(user, passwordResetData.Subject, template, systemDefaults.Notifications, true)
 }
--- a/internal/notification/types/phone_verification_code.go
+++ b/internal/notification/types/phone_verification_code.go
@@ -1,9 +1,12 @@
 package types

 import (
+	"fmt"
+
 	"github.com/caos/zitadel/internal/config/systemdefaults"
 	"github.com/caos/zitadel/internal/crypto"
-	iam_model "github.com/caos/zitadel/internal/iam/model"
+	"github.com/caos/zitadel/internal/domain"
+	"github.com/caos/zitadel/internal/i18n"
 	"github.com/caos/zitadel/internal/notification/templates"
 	es_model "github.com/caos/zitadel/internal/user/repository/eventsourcing/model"
 	view_model "github.com/caos/zitadel/internal/user/repository/view/model"
@@ -13,7 +16,7 @@ type PhoneVerificationCodeData struct {
 	UserID string
 }

-func SendPhoneVerificationCode(text *iam_model.MessageTextView, user *view_model.NotifyUser, code *es_model.PhoneCode, systemDefaults systemdefaults.SystemDefaults, alg crypto.EncryptionAlgorithm) error {
+func SendPhoneVerificationCode(translator *i18n.Translator, user *view_model.NotifyUser, code *es_model.PhoneCode, systemDefaults systemdefaults.SystemDefaults, alg crypto.EncryptionAlgorithm) error {
 	codeString, err := crypto.DecryptString(code.Code, alg)
 	if err != nil {
 		return err
@@ -21,10 +24,10 @@ func SendPhoneVerificationCode(text *iam_model.MessageTextView, user *view_model
 	var args = mapNotifyUserToArgs(user)
 	args["Code"] = codeString

-	text.Text, err = templates.ParseTemplateText(text.Text, args)
+	text := translator.Localize(fmt.Sprintf("%s.%s", domain.VerifyPhoneMessageType, domain.MessageTitle), args, user.PreferredLanguage)

 	codeData := &PhoneVerificationCodeData{UserID: user.ID}
-	template, err := templates.ParseTemplateText(text.Text, codeData)
+	template, err := templates.ParseTemplateText(text, codeData)
 	if err != nil {
 		return err
 	}