Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Notification Email Templates #13940

Open
wants to merge 60 commits into
base: main
Choose a base branch
from

Conversation

TimVanOnckelen
Copy link

@TimVanOnckelen TimVanOnckelen commented Nov 5, 2024

This PR introduces a feature to allow system users to customize the text of email notifications by setting up custom templates in the system settings. Users can tailor their email content with dynamic tags, and HTML is supported for formatting. This update aims to improve flexibility and personalization in user communications.

Key Changes

  • Added a new tab in system settings for custom email templates
  • Enabled HTML support and dynamic tag usage within templates
  • Preview on email templates in the backend
  • Updated documentation to reflect these changes
  • Added localization support for English (EN) and Dutch (NL)

This enhancement enables administrators to align notifications with specific branding or informational needs more effectively.
user-notifications-templates

Preview of email template

@github-actions github-actions bot added documentation Improvements or additions to documentation 🖥️web 🗄️server labels Nov 5, 2024
@TimVanOnckelen TimVanOnckelen changed the title Feat: Notification Email Templates feat: Notification Email Templates Nov 5, 2024
@alextran1502
Copy link
Contributor

Without the HTML viewer for styling and such, it is very hard to check for the modification, right?

@TimVanOnckelen
Copy link
Author

Without the HTML viewer for styling and such, it is very hard to check for the modification, right?

It may indeed be handy to have a preview to check the modifications. The implementation right now is bare bones. A basic optimization would be to either add a wysiwyg editor, or add the ability to send a test mail?

@TimVanOnckelen TimVanOnckelen marked this pull request as draft November 6, 2024 11:13
@TimVanOnckelen
Copy link
Author

I will temporary set this PR back to draft until the svelte 5 migration is done.

@TimVanOnckelen TimVanOnckelen marked this pull request as ready for review November 15, 2024 16:26
@TimVanOnckelen
Copy link
Author

@alextran1502 , the PR is ready for review after your svelte 5 migration.

docs/docs/administration/email-notification.mdx Outdated Show resolved Hide resolved
docs/docs/administration/email-notification.mdx Outdated Show resolved Hide resolved
i18n/en.json Show resolved Hide resolved
i18n/en.json Outdated Show resolved Hide resolved
i18n/en.json Outdated Show resolved Hide resolved
server/src/services/notification.service.ts Show resolved Hide resolved
server/src/utils/replace-template-tags.ts Outdated Show resolved Hide resolved
server/src/services/base.service.ts Outdated Show resolved Hide resolved
server/src/emails/templates/album-invite.ts Outdated Show resolved Hide resolved
@TimVanOnckelen
Copy link
Author

Changes stated in the reviews are added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants