Changes between Version 2 and Version 3 of TracNotification


Ignore:
Timestamp:
Jul 31, 2025, 11:43:28 AM (3 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v2 v3  
    22[[TracGuideToc]]
    33
    4 Trac supports notification of ticket changes via email. 
    5 
    6 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.
    7 
    8 Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
     4Trac supports notification of ticket changes via email.
     5
     6Email 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.
     7
     8Disabled by default, notification can be activated and configured in [TracIni trac.ini].
    99
    1010== Receiving Notification Mails
    11 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.
     11When 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.
     12
     13Permission groups can also be entered in the CC field,
     14to notify all members of the group.
    1215
    1316=== How to use your username to receive notification mails
    1417
    15 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.
     18To 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].
    1619
    1720Alternatively, 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.
    1821
    19 When using apache and mod_kerb for authentication against Kerberos / Active Directory, usernames take the form ('''`username@EXAMPLE.LOCAL`'''). To avoid this being interpreted as an email address, add the Kerberos domain to  ('''`ignore_domains`''').
     22When using apache and mod_kerb for authentication against Kerberos / Active Directory, usernames take the form ('''`username@EXAMPLE.LOCAL`'''). To avoid this being interpreted as an email address, add the Kerberos domain to ('''`ignore_domains`''').
    2023
    2124=== Ticket attachment notifications
    … …  
    2932== Configuring SMTP Notification
    3033
    31 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
     34'''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated.
    3235
    3336=== Configuration Options
    … …  
    5861
    5962=== Subscriber Configuration
    60 The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
     63The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
    6164
    6265[[TracIni(section=notification-subscriber)]]
    6366
    64 Each user can override these defaults in his ''Notifications'' preferences.
     67Each user can override these defaults in their ''Notifications'' preferences.
    6568
    6669For 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.
    … …  
    7073The following attributes of default subscriptions can be configured:
    7174* `.distributor` (Default: `email`)
    72   * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.
     75  * Other values require plugins. For example `on-site` requires [https://trac-hacks.org/wiki/OnSiteNotificationsPlugin OnSiteNotificationsPlugin].
    7376* `.priority` (Default: `100`)
    7477  * Smaller values override larger values.
    … …  
    7780  * `never` can be used to silence other subscription rules with higher values.
    7881* `.format` (Default: `text/plain`)
    79   * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.
     82  * Other values require plugins. For example `text/html` requires [https://trac-hacks.org/wiki/TracHtmlNotificationPlugin TracHtmlNotificationPlugin].
    8083
    8184=== Example Configuration (default subscriptions)
     85
     86This example implements the often desired
     87//Never Notify Updater// behavior by setting
     88the priority of that rule to the highest value,
     89thereby taking precedence over other rules.
     90
    8291{{{#!ini
    8392[notification-subscriber]
    … …  
    98107}}}
    99108
    100 === Customizing the e-mail subject
    101 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 Genshi text template] snippet. The default value is:
     109=== Customizing the email subject
     110The 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:
    102111{{{#!genshi
    103112${prefix} #${ticket.id}: ${summary}
    … …  
    105114The following variables are available in the template:
    106115
    107  * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     116 * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]).
     117 * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]).
    108118 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    109119 * `summary`: The ticket summary, with the old value if the summary was edited.
    110  * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, eg `${ticket.milestone}`.
    111 
    112 === Customizing the e-mail content
    113 
    114 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:
    115 
    116 {{{#!genshi
     120 * `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}`.
     121
     122=== Customizing the email content #CustomizingContent
     123
     124The 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:
     125
     126{{{#!jinja
    117127${ticket_body_hdr}
    118128${ticket_props}
    119 {% choose ticket.new %}\
    120 {%   when True %}\
     129# if ticket.new:
    121130${ticket.description}
    122 {%   end %}\
    123 {%   otherwise %}\
    124 {%     if changes_body %}\
     131# else:
     132#   if changes_body:
    125133${_('Changes (by %(author)s):', author=change.author)}
    126134
    127135${changes_body}
    128 {%     end %}\
    129 {%     if changes_descr %}\
    130 {%       if not changes_body and not change.comment and change.author %}\
     136#   endif
     137#   if changes_descr:
     138#     if not changes_body and not change.comment and change.author:
    131139${_('Description changed by %(author)s:', author=change.author)}
    132 {%       end %}\
     140#     endif
    133141${changes_descr}
    134142--
    135 {%     end %}\
    136 {%     if change.comment %}\
    137 
    138 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     143#   endif
     144#   if change.comment:
     145
     146${_('Comment:') if changes_body else
     147  _('Comment (by %(author)s):', author=change.author)}
    139148
    140149${change.comment}
    141 {%     end %}\
    142 {%   end %}\
    143 {% end %}\
    144 
    145 --
     150#   endif
     151# endif
     152${'-- '}
    146153${_('Ticket URL: <%(link)s>', link=ticket.link)}
    147154${project.name} <${project.url or abs_href()}>
    148155${project.descr}
    149156}}}
     157
     158See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
    150159
    151160== Sample Email
    … …  
    153162#42: testing
    154163---------------------------+------------------------------------------------
    155        Id:  42             |      Status:  assigned               
     164       Id:  42             |      Status:  assigned
    156165Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
    157  Severity:  major          |   Milestone:  0.9                     
    158  Priority:  lowest         |     Version:  0.6                     
    159     Owner:  anonymous      |    Reporter:  jonas@example.com               
     166 Severity:  major          |   Milestone:  0.9
     167 Priority:  lowest         |     Version:  0.6
     168    Owner:  anonymous      |    Reporter:  jonas@example.com
    160169---------------------------+------------------------------------------------
    161170Changes:
    … …  
    175184}}}
    176185
    177 == Customizing e-mail content for MS Outlook
    178 
    179 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].
    180 
    181 Replace the following second row in the template:
    182 {{{
    183 ${ticket_props}
    184 }}}
    185 
    186 with this (requires Python 2.6 or later):
    187 {{{
    188 --------------------------------------------------------------------------
    189 {% with
    190    pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
    191          [c.strip() for c in
    192           ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
    193    sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
    194           'Component', 'Severity', 'Resolution', 'Keywords'] %}\
    195 ${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
    196 {% end %}\
    197 --------------------------------------------------------------------------
    198 }}}
    199 
    200 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.
    201 {{{#!div style="margin: 1em 1.75em; border:1px dotted"
    202 {{{#!html
    203 #42: testing<br />
    204 --------------------------------------------------------------------------<br />
    205 <table cellpadding=0>
    206 <tr><td>Reporter:</td><td>jonas@example.com</td></tr>
    207 <tr><td>Owner:</td><td>anonymous</td></tr>
    208 <tr><td>Type:</td><td>defect</td></tr>
    209 <tr><td>Status:</td><td>assigned</td></tr>
    210 <tr><td>Priority:</td><td>lowest</td></tr>
    211 <tr><td>Milestone:</td><td>0.9</td></tr>
    212 <tr><td>Component:</td><td>report system</td></tr>
    213 <tr><td>Severity:</td><td>major</td></tr>
    214 <tr><td>Resolution:</td><td> </td></tr>
    215 <tr><td>Keywords:</td><td> </td></tr>
    216 </table>
    217 --------------------------------------------------------------------------<br />
    218 Changes:<br />
    219 <br />
    220 &nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    221 &nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    222 &nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
    223 &nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
    224 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
    225 &nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
    226 <br />
    227 Comment:<br />
    228 I'm interested too!<br />
    229 <br />
    230 --<br />
    231 Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
    232 My Project &lt;http://myproj.example.com/&gt;<br />
    233 }}}
    234 }}}
    235 
    236 **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:
    237 {{{
    238    sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    239 }}}
    240 
    241 However, the solution is still a workaround to an automatically HTML-formatted e-mail.
    242 
    243186== Using GMail as the SMTP relay host
    244187
    … …  
    255198}}}
    256199
    257 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     200where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com].
    258201
    259202Alternatively, you can use `smtp_port = 25`.[[br]]
    … …  
    262205== Troubleshooting
    263206
    264 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.
    265 
    266 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.
    267 
    268 === ''Permission denied'' error
     207If notifications are not working, inspect the [TracLogging log] for error messages.
     208
     209Notification 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.
     210
     211=== Permission denied error
    269212
    270213Typical error message:
    … …  
    297240}}}
    298241
    299 === ''Suspected spam'' error
     242=== Suspected spam error
    300243
    301244Some SMTP servers may reject the notification email sent by Trac.
    … …  
    304247
    305248Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
     249
     250=== Emails not sent
     251
     252If you are switching back to using Trac to send emails from, say, the [https://trac-hacks.org/wiki/AnnouncerPlugin AnnouncerPlugin], be sure to enable `EmailDistributor` in your Trac configuration. It may have been disabled when using an email plugin. There may be no message in the Trac log when all is good to go, but the actual sending is disabled.
    306253
    307254----