Changes between Version 4 and Version 5 of TracNotification


Ignore:
Timestamp:
Sep 14, 2021, 8:32:09 AM (8 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v4 v5  
    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.
     
    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
    3437These are the available options for the `[notification]` section in trac.ini:
    3538
    36 [[TracIni(notification)]]
     39[[TracIni(section=notification)]]
    3740
    3841=== Example Configuration (SMTP)
     
    5861
    5962=== Subscriber Configuration
    60 The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
    61 
    62 [[TracIni(notification-subscriber)]]
    63 
    64 Each user can override these defaults in his ''Notifications'' preferences.
     63The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
     64
     65[[TracIni(section=notification-subscriber)]]
     66
     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.
    6770
    68 === Customizing the e-mail subject
    69 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:
     71The 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.
     72
     73The following attributes of default subscriptions can be configured:
     74* `.distributor` (Default: `email`)
     75  * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.
     76* `.priority` (Default: `100`)
     77  * Smaller values override larger values.
     78  * If you use `0`, then users will not be able to override this rule.
     79* `.adverb` (Default: `always`)
     80  * `never` can be used to silence other subscription rules with higher values.
     81* `.format` (Default: `text/plain`)
     82  * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.
     83
     84=== 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
     91{{{#!ini
     92[notification-subscriber]
     93always_notify_owner = TicketOwnerSubscriber
     94always_notify_owner.distributor = email
     95always_notify_owner.priority = 100
     96always_notify_owner.adverb = always
     97always_notify_owner.format = text/plain
     98
     99always_notify_previous_updater = TicketPreviousUpdatersSubscriber
     100
     101never_notify_updater = TicketUpdaterSubscriber
     102never_notify_updater.adverb = never
     103never_notify_updater.priority = 0
     104
     105notify_cc_html = CarbonCopySubscriber
     106notify_cc_html.format = text/html
     107}}}
     108
     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:
    70111{{{#!genshi
    71 $prefix #$ticket.id: $summary
     112${prefix} #${ticket.id}: ${summary}
    72113}}}
    73114The following variables are available in the template:
    74115
    75  * `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]).
    76118 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    77119 * `summary`: The ticket summary, with the old value if the summary was edited.
    78  * `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`.
    79 
    80 === Customizing the e-mail content
    81 
    82 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:
    83 
    84 {{{#!genshi
    85 $ticket_body_hdr
    86 $ticket_props
    87 {% choose ticket.new %}\
    88 {%   when True %}\
    89 $ticket.description
    90 {%   end %}\
    91 {%   otherwise %}\
    92 {%     if changes_body %}\
     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
     127${ticket_body_hdr}
     128${ticket_props}
     129# if ticket.new:
     130${ticket.description}
     131# else:
     132#   if changes_body:
    93133${_('Changes (by %(author)s):', author=change.author)}
    94134
    95 $changes_body
    96 {%     end %}\
    97 {%     if changes_descr %}\
    98 {%       if not changes_body and not change.comment and change.author %}\
     135${changes_body}
     136#   endif
     137#   if changes_descr:
     138#     if not changes_body and not change.comment and change.author:
    99139${_('Description changed by %(author)s:', author=change.author)}
    100 {%       end %}\
    101 $changes_descr
     140#     endif
     141${changes_descr}
    102142--
    103 {%     end %}\
    104 {%     if change.comment %}\
    105 
    106 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
    107 
    108 $change.comment
    109 {%     end %}\
    110 {%   end %}\
    111 {% end %}\
    112 
    113 --
     143#   endif
     144#   if change.comment:
     145
     146${_('Comment:') if changes_body else
     147  _('Comment (by %(author)s):', author=change.author)}
     148
     149${change.comment}
     150#   endif
     151# endif
     152${'-- '}
    114153${_('Ticket URL: <%(link)s>', link=ticket.link)}
    115 $project.name <${project.url or abs_href()}>
    116 $project.descr
    117 }}}
     154${project.name} <${project.url or abs_href()}>
     155${project.descr}
     156}}}
     157
     158See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
    118159
    119160== Sample Email
     
    121162#42: testing
    122163---------------------------+------------------------------------------------
    123        Id:  42             |      Status:  assigned               
     164       Id:  42             |      Status:  assigned
    124165Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
    125  Severity:  major          |   Milestone:  0.9                     
    126  Priority:  lowest         |     Version:  0.6                     
    127     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
    128169---------------------------+------------------------------------------------
    129170Changes:
     
    143184}}}
    144185
    145 == Customizing e-mail content for MS Outlook
    146 
    147 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].
    148 
    149 Replace the following second row in the template:
    150 {{{
    151 $ticket_props
    152 }}}
    153 
    154 with this (requires Python 2.6 or later):
    155 {{{
    156 --------------------------------------------------------------------------
    157 {% with
    158    pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
    159          [c.strip() for c in
    160           ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
    161    sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
    162           'Component', 'Severity', 'Resolution', 'Keywords'] %}\
    163 ${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
    164 {% end %}\
    165 --------------------------------------------------------------------------
    166 }}}
    167 
    168 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.
    169 {{{#!div style="margin: 1em 1.75em; border:1px dotted"
    170 {{{#!html
    171 #42: testing<br />
    172 --------------------------------------------------------------------------<br />
    173 <table cellpadding=0>
    174 <tr><td>Reporter:</td><td>jonas@example.com</td></tr>
    175 <tr><td>Owner:</td><td>anonymous</td></tr>
    176 <tr><td>Type:</td><td>defect</td></tr>
    177 <tr><td>Status:</td><td>assigned</td></tr>
    178 <tr><td>Priority:</td><td>lowest</td></tr>
    179 <tr><td>Milestone:</td><td>0.9</td></tr>
    180 <tr><td>Component:</td><td>report system</td></tr>
    181 <tr><td>Severity:</td><td>major</td></tr>
    182 <tr><td>Resolution:</td><td> </td></tr>
    183 <tr><td>Keywords:</td><td> </td></tr>
    184 </table>
    185 --------------------------------------------------------------------------<br />
    186 Changes:<br />
    187 <br />
    188 &nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    189 &nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    190 &nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
    191 &nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
    192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
    193 &nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
    194 <br />
    195 Comment:<br />
    196 I'm interested too!<br />
    197 <br />
    198 --<br />
    199 Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
    200 My Project &lt;http://myproj.example.com/&gt;<br />
    201 }}}
    202 }}}
    203 
    204 **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:
    205 {{{
    206    sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    207 }}}
    208 
    209 However, the solution is still a workaround to an automatically HTML-formatted e-mail.
    210 
    211186== Using GMail as the SMTP relay host
    212187
     
    223198}}}
    224199
    225 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].
    226201
    227202Alternatively, you can use `smtp_port = 25`.[[br]]
     
    230205== Troubleshooting
    231206
    232 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.
    233 
    234 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.
     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.
    235210
    236211=== ''Permission denied'' error