Add email templates for shared item notifications

2026-09-24 16:30:27 +08:00 · 2024-04-16 17:06:15 +02:00
parent f2641d12e5
commit a6ba1a8cbb
2 changed files with 115 additions and 0 deletions
@@ -0,0 +1,74 @@
+Use this template to customize the HTML email your users will receive
+when a new notification of category "new_shared_item" is sent to them.
+Copy the file to {{ templates_dir }}/mail/notifications/new_shared_item-email.html and modify as required.
+
+If you are adding URLs into this, remember that only absolute URLS (with
+a domain name) make sense in email! They can be served from any stable
+location, including your Galaxy server or GitHub.
+
+The following variables are available for inserting into the html with Jinja2
+syntax, like {{ variable_name }}. They will be rendered into the text before
+the email is sent:
+
+- name                      The user's name
+- user_email                The user's email
+- date                      Date and time of the notification
+- hostname                  Your galaxy's hostname
+- contact_email             Your galaxy's contact email
+- notification_settings_url The URL to the user's notification settings to manage their subscriptions
+- content                   The new_shared_item payload
+  - item_type               The type of the shared item
+  - item_name               The name of the shared item
+  - owner_name              The name of the owner of the shared item
+  - slug                    The slug of the shared item. Used for the link to the item.
+
+Template begins here >>>>>>
+<!DOCTYPE html>
+<html lang="en" dir="ltr">
+  <head>
+    <meta charset="utf-8">
+    <title>[Galaxy] New {{ content['item_type'] }} shared with you: </title>
+    <link href="https://fonts.googleapis.com/css2?family=Roboto&display=swap" rel="stylesheet">
+  </head>
+  <body style="font-family: 'Roboto', sans-serif;">
+
+    <p style="font-size: 12pt;">
+      Hello {{ name }},<br><br>
+
+      A new <b>{{ content['item_type'] }}</b> named <i>{{ content['item_name'] }}</i> has been shared with you on <b>{{ date }}</b> by <b>{{ content['owner_name'] }}</b>.
+    </p>
+
+    <p style="font-size: 12pt;">
+      To access the shared {{ content['item_type'] }}, please visit the following link:
+      <br>
+      <a href="{{ content['slug'] }}">{{ content['item_name'] }}</a>
+      <br><br>
+    
+    <p style="font-size: 12pt;">
+      Thank you for using Galaxy!
+    </p>
+    
+
+    <p style="font-size: 12pt;">
+      Regards,<br>
+      Your Galaxy Team at {{ hostname }}
+    </p>
+
+    <p style="font-size: 10pt;">
+      This is an automated email. If you have any questions or concerns, please do not reply to this email, instead, contact us at <a href="mailto:{{ contact_email }}">{{ contact_email }}</a>.<br><br>
+
+      You received this email because you are subscribed to receive notifications when another user shares an item with you.
+      <br>
+      You can manage your notification settings <a href="{{ notification_settings_url }}">here</a>.
+    </p>
+
+    <img
+      style="width: 130px; height: auto; margin: 15px 0;"
+      src="https://galaxyproject.org/images/galaxy-logos/galaxy_project_logo_square.png"
+      alt="Galaxy project logo"
+    >
+
+    <br>
+
+  </body>
+</html>
@@ -0,0 +1,41 @@
+Use this template to customize the text email your users will receive
+when a new notification of category "new_shared_item" is sent to them.
+Copy the file to {{ templates_dir }}/mail/notifications/new_shared_item-email.txt and modify as required.
+
+If you are adding URLs into this, remember that only absolute URLS (with
+a domain name) make sense in email! They can be served from any stable
+location, including your Galaxy server or GitHub.
+
+The following variables are available for inserting into the text like
+{{ variable_name }}. They will be rendered into the text before the email is
+sent:
+
+- name                      The user's name
+- user_email                The user's email
+- date                      Date and time of the notification
+- hostname                  Your galaxy's hostname
+- contact_email             Your galaxy's contact email
+- notification_settings_url The URL to the user's notification settings to manage their subscriptions
+- content                   The new_shared_item payload
+  - item_type               The type of the shared item
+  - item_name               The name of the shared item
+  - owner_name              The name of the owner of the shared item
+  - slug                    The slug of the shared item. Used for the link to the item.
+
+Template begins here>>>>>>
+Hello {{ name }},
+
+A new {{ content['item_type'] }} has been shared with you by {{ content['owner_name'] }}.
+
+To access the shared {{ content['item_type'] }}, please visit the following link:
+{{ hostname }}/{{ content['slug'] }}
+
+You received this email because you are subscribed to receive notifications when another user shares an item with you.
+To manage your notification settings, please visit {{ notification_settings_url }}.
+
+If you have any questions, please contact us at {{ contact_email }}.
+
+Thank you for using Galaxy!
+
+Regards,
+Your Galaxy Team