Context Navigation

← Previous Change
Wiki History
Next Change →

Changes between Version 5 and Version 6 of TracNotification

Timestamp:: Jul 11, 2021, 2:17:40 PM (3 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

TracNotification

-              v5
+              v6
 [[TracGuideToc]]
 Trac supports notification of ticket changes via email.
 Email notification is useful to keep users up-to-date on tickets/issues of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list. For example, this is how the [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] mailing list is set up.
 Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
+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.
+Disabled by default, notification can be activated and configured in [TracIni trac.ini].
 == Receiving Notification Mails
 …
 === 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 the ''Preferences'' page.
+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.
 …
 == Configuring SMTP Notification
 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
+'''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
 …
 === Subscriber Configuration
 The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
+The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
 [[TracIni(section=notification-subscriber)]]
 Each user can override these defaults in his ''Notifications'' preferences.
+Each user can override these defaults in their ''Notifications'' preferences.
 For example to unsubscribe from notifications for one's own changes and comments, the rule "Never notify: I update a ticket" should be added above other subscription rules.
+=== Customizing the e-mail subject
+The e-mail subject can be customized with the `ticket_subject_template` option, which contains a [http://genshi.edgewall.org/wiki/Documentation/text-templates.html text template] snippet. The default value is:
+The subscription rule name on the left side of the `=` can be anything, it has no meaning outside this configuration file. The subscriber name on the right side of the `=` must be one of the subscribers listed in the above table.
+The following attributes of default subscriptions can be configured:
+* `.distributor` (Default: `email`)
+  * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.
+* `.priority` (Default: `100`)
+  * Smaller values override larger values.
+  * If you use `0`, then users will not be able to override this rule.
+* `.adverb` (Default: `always`)
+  * `never` can be used to silence other subscription rules with higher values.
+* `.format` (Default: `text/plain`)
+  * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.
+=== 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]
+always_notify_owner = TicketOwnerSubscriber
+always_notify_owner.distributor = email
+always_notify_owner.priority = 100
+always_notify_owner.adverb = always
+always_notify_owner.format = text/plain
+always_notify_previous_updater = TicketPreviousUpdatersSubscriber
+never_notify_updater = TicketUpdaterSubscriber
+never_notify_updater.adverb = never
+never_notify_updater.priority = 0
+notify_cc_html = CarbonCopySubscriber
+notify_cc_html.format = text/html
+}}}
+=== Customizing the email subject
+The email subject can be customized with the `ticket_subject_template` option, which contains a [https://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet. The default value is:
 {{{#!genshi
 ${prefix} #${ticket.id}: ${summary}
 …
 The following variables are available in the template:
  * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]).
+ * `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.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 e-mail content
+The notification e-mail 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 looks like this:
+{{{#!genshi
+$ticket_body_hdr
+$ticket_props
+{% choose ticket.new %}\
+{%   when True %}\
+$ticket.description
+{%   end %}\
+{%   otherwise %}\
+{%     if changes_body %}\
+ * `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:
+{{{#!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 %}\
+${changes_body and _('Comment:') or _('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}
+}}}
+See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
 == Sample Email
 …
 #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:
 …
 }}}
-== Customizing e-mail content for MS Outlook
-MS Outlook normally presents plain text e-mails with a variable-width font, and as a result the ticket properties table will most certainly look like a mess in MS Outlook. This can be fixed with some customization of the [#Customizingthee-mailcontent e-mail template].
-Replace the following second row in the template:
-{{{
-$ticket_props
-}}}
-with this (requires Python 2.6 or later):
-{{{
---------------------------------------------------------------------------
-{% with
-   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
-         [c.strip() for c in
-          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
-   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
-          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
-${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
-{% end %}\
---------------------------------------------------------------------------
-}}}
-The table of ticket properties is replaced with a list of a selection of the properties. A tab character separates the name and value in such a way that most people should find this more pleasing than the default table when using MS Outlook.
-{{{#!div style="margin: 1em 1.75em; border:1px dotted"
-{{{#!html
-#42: testing<br />
---------------------------------------------------------------------------<br />
-<table cellpadding=0>
-<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
-<tr><td>Owner:</td><td>anonymous</td></tr>
-<tr><td>Type:</td><td>defect</td></tr>
-<tr><td>Status:</td><td>assigned</td></tr>
-<tr><td>Priority:</td><td>lowest</td></tr>
-<tr><td>Milestone:</td><td>0.9</td></tr>
-<tr><td>Component:</td><td>report system</td></tr>
-<tr><td>Severity:</td><td>major</td></tr>
-<tr><td>Resolution:</td><td> </td></tr>
-<tr><td>Keywords:</td><td> </td></tr>
-</table>
---------------------------------------------------------------------------<br />
-Changes:<br />
-<br />
-&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
-&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
-&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
-&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
-&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
-<br />
-Comment:<br />
-I'm interested too!<br />
-<br />
---<br />
-Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
-My Project &lt;http://myproj.example.com/&gt;<br />
-}}}
-}}}
-**Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which are to be part of the mail, then they have to be added to `sel`. Example:
-{{{
-   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
-}}}
-However, the solution is still a workaround to an automatically HTML-formatted e-mail.
 == Using GMail as the SMTP relay host
 …
 }}}
 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
+where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com].
 Alternatively, you can use `smtp_port = 25`.[[br]]
 …
 == Troubleshooting
 If you cannot get the notification working, first make sure the log is activated and have a look at the log to find if an error message has been logged. See TracLogging for help about the log feature.
 Notification errors are not reported through the web interface, so the user who submits a change or a new ticket never gets notified about a notification failure. The Trac administrator needs to look at the log to find the error trace.
+If notifications are not working, inspect the [TracLogging log] for error messages.
+Notification errors are not always reported through the web interface, so the user who submits a change or creates a ticket may not get notified about a notification failure. The Trac administrator needs to look at the log to find the error message and traceback.
 === ''Permission denied'' error