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

Merged
Merged
Show file tree
Hide file tree
Changes from 54 commits
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
755a0b4
added template types
TimVanOnckelen Oct 31, 2024
04aa32c
updated open-api reference
TimVanOnckelen Oct 31, 2024
d85d406
optimized naming
TimVanOnckelen Oct 31, 2024
d46cfcd
added textareas for all email notifications
TimVanOnckelen Oct 31, 2024
7266f5c
basic template implementation on email notifications.
TimVanOnckelen Nov 5, 2024
784d859
added translations, optimized layout
TimVanOnckelen Nov 5, 2024
a378cbb
updated docs on notification templates
TimVanOnckelen Nov 5, 2024
d655d8a
reworked based on tests
TimVanOnckelen Nov 5, 2024
b04a765
Merge branch 'main' into feat/notification-email-templates
TimVanOnckelen Nov 5, 2024
af0e694
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 5, 2024
cb86905
moved notification template screenshot
TimVanOnckelen Nov 5, 2024
3ce51b6
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 6, 2024
bea2a83
added api route to get templates
TimVanOnckelen Nov 6, 2024
b842d7e
Merge commit '3ce51b65d0d58275046f5257a36b4dc3b54a6395' into feat/not…
TimVanOnckelen Nov 6, 2024
7c8c0e0
updated openapi
TimVanOnckelen Nov 6, 2024
78f19d5
updated api
TimVanOnckelen Nov 6, 2024
4673779
updated translations
TimVanOnckelen Nov 6, 2024
12949e2
preset of wysiwyg editor
TimVanOnckelen Nov 6, 2024
0b2e5d9
updated template preview parameters
TimVanOnckelen Nov 6, 2024
781b726
preview shown within iframe to keep styling clean.
TimVanOnckelen Nov 6, 2024
19cf7b9
fixed lint errors
TimVanOnckelen Nov 6, 2024
f7612de
updated doc image
TimVanOnckelen Nov 6, 2024
20df713
Merge branch 'immich-app:main' into feat/notification-email-template
TimVanOnckelen Nov 6, 2024
b66e306
Merge branch 'immich-app:main' into feat/notification-email-template
TimVanOnckelen Nov 6, 2024
3fc51f8
migrate to svelte 5 syntax
TimVanOnckelen Nov 6, 2024
f30a434
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 6, 2024
4fb8d78
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 6, 2024
564cf1d
migrated to svelte 5 syntax
TimVanOnckelen Nov 6, 2024
2541eb5
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 7, 2024
457b9f7
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 7, 2024
6b93130
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 7, 2024
086d0ff
fixing lint error on server
TimVanOnckelen Nov 7, 2024
3c2cf95
fixed issue with translations in lint (hidden char?)
TimVanOnckelen Nov 7, 2024
c950695
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 7, 2024
0b83a36
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 7, 2024
a72a0e7
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 7, 2024
74a9a55
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 7, 2024
28c5764
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 8, 2024
aaea305
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 8, 2024
30eb30a
Merge branch 'immich-app:main' into feat/notification-email-template
TimVanOnckelen Nov 10, 2024
9a4fb0d
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 11, 2024
df20cd5
Merge branch 'immich-app:main' into feat/notification-email-template
TimVanOnckelen Nov 15, 2024
5f7215c
updated config to be bindable
TimVanOnckelen Nov 15, 2024
33afaf7
fixed disabled prop to optional
TimVanOnckelen Nov 15, 2024
eebafb5
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 15, 2024
bbea406
Update docs/docs/administration/email-notification.mdx
TimVanOnckelen Nov 16, 2024
bf66fb1
Update i18n/en.json
TimVanOnckelen Nov 16, 2024
cfb70b5
Update i18n/en.json
TimVanOnckelen Nov 16, 2024
6844aa7
notificationRepository is unused here
TimVanOnckelen Nov 16, 2024
c1205d4
review fixes
TimVanOnckelen Nov 16, 2024
c110bc0
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 18, 2024
8fe1540
Merge branch 'main' into feat/notification-email-template
alextran1502 Nov 19, 2024
747c6e1
fixed review issues
TimVanOnckelen Nov 22, 2024
ed9bf9c
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 22, 2024
5a7e6eb
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 25, 2024
ed34516
renamed htmltemplate
TimVanOnckelen Nov 25, 2024
c2d1b09
moved templates to the notifications tab
TimVanOnckelen Nov 25, 2024
ad7bd7b
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 25, 2024
e5b1e58
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Nov 29, 2024
73de52b
renamed tempTemplate to customTemplate
TimVanOnckelen Nov 29, 2024
01d8833
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Dec 1, 2024
498af7a
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Dec 3, 2024
f82c0da
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Dec 3, 2024
a0ca51c
lint
alextran1502 Dec 4, 2024
c2c01fc
chore: rename dto property
alextran1502 Dec 4, 2024
097aa9e
Merge branch 'main' into feat/notification-email-template
TimVanOnckelen Dec 4, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/docs/administration/email-notification.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,9 @@ You can use [this guide](/docs/guides/smtp-gmail) to use Gmail's SMTP server.
Users can manage their email notification settings from their account settings page on the web. They can choose to turn email notifications on or off for the following events:

<img src={require('./img/user-notifications-settings.png').default} width="80%" title="User notification settings" />

## Notification templates

You can override the default notification text with custom templates in HTML format. You can use tags to show dynamic tags in your templates.

<img src={require('./img/user-notifications-templates.png').default} width="80%" title="User notification templates" />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/docs/administration/system-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,10 @@ Immich supports [Reverse Geocoding](/docs/features/reverse-geocoding) using data

SMTP server setup, for user creation notifications, new albums, etc. More information can be found [here](/docs/administration/email-notification)

## Notification Templates

Override the default notifications text with notification templates. More information can be found [here](/docs/administration/email-notification)

## Server Settings

### External Domain
Expand Down
12 changes: 11 additions & 1 deletion i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,16 @@
"storage_template_user_label": "<code>{label}</code> is the user's Storage Label",
"system_settings": "System Settings",
"tag_cleanup_job": "Tag cleanup",
"template_email_preview": "Preview",
"template_email_settings": "Email",
"template_email_settings_description": "Manage custom email notification templates",
"template_email_welcome": "Welcome email template",
"template_email_invite_album": "Invite Album Template",
"template_email_update_album": "Update Album Template",
"template_settings": "Notification Templates",
"template_settings_description": "Manage custom templates for notifications.",
"template_email_if_empty": "If the template is empty, the default email will be used.",
"template_email_available_tags": "You can use the following variables in your template: {tags}",
"theme_custom_css_settings": "Custom CSS",
"theme_custom_css_settings_description": "Cascading Style Sheets allow the design of Immich to be customized.",
"theme_settings": "Theme Settings",
Expand Down Expand Up @@ -1316,4 +1326,4 @@
"yes": "Yes",
"you_dont_have_any_shared_links": "You don't have any shared links",
"zoom_image": "Zoom Image"
}
}
TimVanOnckelen marked this conversation as resolved.
Show resolved Hide resolved
10 changes: 10 additions & 0 deletions i18n/nl.json
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,16 @@
"storage_template_user_label": "<code>{label}</code> is het opslaglabel van de gebruiker",
"system_settings": "Systeeminstellingen",
"tag_cleanup_job": "Tag opschoning",
"template_email_settings": "Email",
"template_email_settings_description": "Beheer aangepaste email melding sjablonen",
"template_email_preview": "Voorbeeld",
"template_email_welcome": "Welkom email sjabloon",
"template_email_invite_album": "Uitgenodigd in album sjabloon",
"template_email_update_album": "Update in album sjabloon",
"template_settings": "Melding sjablonen",
"template_settings_description": "Beheer aangepast sjablonen voor meldingen.",
"template_email_if_empty": "Wanneer het sjabloon leeg is, wordt de standaard mail gebruikt.",
"template_email_available_tags": "Je kan de volgende tags gebruiken in een template: {tags}",
"theme_custom_css_settings": "Aangepaste CSS",
"theme_custom_css_settings_description": "Met Cascading Style Sheets kan het ontwerp van Immich worden aangepast.",
"theme_settings": "Thema instellingen",
Expand Down
5 changes: 5 additions & 0 deletions mobile/openapi/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions mobile/openapi/lib/api.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

52 changes: 52 additions & 0 deletions mobile/openapi/lib/api/notifications_api.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions mobile/openapi/lib/api_client.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 9 additions & 1 deletion mobile/openapi/lib/model/system_config_dto.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

115 changes: 115 additions & 0 deletions mobile/openapi/lib/model/system_config_template_emails_dto.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading