Changes between Version 17 and Version 18 of TracNotification

Timestamp:

19/04/2022 13:22:07 (3 years ago)

Author:

trac

Comment:

--

TracNotification

@@ -2 +2 @@
 [[TracGuideToc]]
 
-Trac supports notification of ticket changes via email. 
+Trac supports notification of ticket changes via email.
 
 Email notification is useful to keep users up-to-date on tickets of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list.
@@ -9 +9 @@
 
 == Receiving Notification Mails
-When reporting a new ticket or adding a comment, enter a valid email address or your Trac username in the ''reporter'', ''assigned to/owner'' or ''cc'' field. Trac will automatically send you an email when changes are made to the ticket, depending on how notification is configured.
+When reporting a new ticket or adding a comment, enter a valid email address or your Trac username in the ''reporter'', ''assigned to/owner'' or ''cc'' field. Trac may send you an email when changes are made to the ticket, depending on how your notification preferences are configured.
+
+Permission groups can also be entered in the CC field,
+to notify all members of the group.
 
 === How to use your username to receive notification mails
 
-To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in your [/prefs preferences]. 
+To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in your [/prefs preferences].
 
 Alternatively, a default domain name ('''`smtp_default_domain`''') can be set in the TracIni file, see [#ConfigurationOptions Configuration Options] below. In this case, the default domain will be appended to the username, which can be useful for an "Intranet" kind of installation.
@@ -29 +32 @@
 == Configuring SMTP Notification
 
-'''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated. 
+'''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated.
 
 === Configuration Options
@@ -80 +83 @@
 
 === Example Configuration (default subscriptions)
+
+This example implements the often desired
+//Never Notify Updater// behavior by setting
+the priority of that rule to the highest value,
+thereby taking precedence over other rules.
+
 {{{#!ini
 [notification-subscriber]
@@ -105 +114 @@
 The following variables are available in the template:
 
- * `env`: The project environment object (see [trac:source:branches/1.2-stable/trac/env.py env.py]).
+ * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]).
+ * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]).
  * `prefix`: The prefix defined in `smtp_subject_prefix`.
  * `summary`: The ticket summary, with the old value if the summary was edited.
- * `ticket`: The ticket model object (see [trac:source:branches/1.2-stable/trac/ticket/model.py model.py]). Individual ticket fields can be accessed by appending the field name separated by a dot, eg `${ticket.milestone}`.
-
-=== Customizing the email content
+ * `ticket`: The ticket model object (see [trac:source:/branches/1.4-stable/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, eg `${ticket.milestone}`.
+
+=== Customizing the email content #CustomizingContent
 
 The notification email content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. You can add your own version of this template by adding a `ticket_notify_email.txt` to the templates directory of your environment. The default is:
 
-{{{#!genshi
-$ticket_body_hdr
-$ticket_props
-{% choose ticket.new %}\
-{%   when True %}\
-$ticket.description
-{%   end %}\
-{%   otherwise %}\
-{%     if changes_body %}\
+{{{#!jinja
+${ticket_body_hdr}
+${ticket_props}
+# if ticket.new:
+${ticket.description}
+# else:
+#   if changes_body:
 ${_('Changes (by %(author)s):', author=change.author)}
 
-$changes_body
-{%     end %}\
-{%     if changes_descr %}\
-{%       if not changes_body and not change.comment and change.author %}\
+${changes_body}
+#   endif
+#   if changes_descr:
+#     if not changes_body and not change.comment and change.author:
 ${_('Description changed by %(author)s:', author=change.author)}
-{%       end %}\
-$changes_descr
+#     endif
+${changes_descr}
 --
-{%     end %}\
-{%     if change.comment %}\
-
-${_('Comment:') if changes_body else _('Comment (by %(author)s):', author=change.author)}
-
-$change.comment
-{%     end %}\
-{%   end %}\
-{% end %}\
-
+#   endif
+#   if change.comment:
+
+${_('Comment:') if changes_body else
+  _('Comment (by %(author)s):', author=change.author)}
+
+${change.comment}
+#   endif
+# endif
 ${'-- '}
 ${_('Ticket URL: <%(link)s>', link=ticket.link)}
-$project.name <${project.url or abs_href()}>
-$project.descr
+${project.name} <${project.url or abs_href()}>
+${project.descr}
 }}}
 
@@ -155 +162 @@
 #42: testing
 ---------------------------+------------------------------------------------
-       Id:  42             |      Status:  assigned                
+       Id:  42             |      Status:  assigned
 Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
- Severity:  major          |   Milestone:  0.9                     
- Priority:  lowest         |     Version:  0.6                     
-    Owner:  anonymous      |    Reporter:  jonas@example.com               
+ Severity:  major          |   Milestone:  0.9
+ Priority:  lowest         |     Version:  0.6
+    Owner:  anonymous      |    Reporter:  jonas@example.com
 ---------------------------+------------------------------------------------
 Changes: