Changes between Version 3 and Version 4 of TracNotification


Ignore:
Timestamp:
2024-11-18T21:51:26Z (6 days ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v3 v4  
    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 
    12 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.
    1315
    1416=== How to use your username to receive notification mails
    1517
    16 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].
    1719
    1820Alternatively, 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.
    … …  
    3032== Configuring SMTP Notification
    3133
    32 '''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.
    3335
    3436=== Configuration Options
    35 
    36 These are the available options for the `[notification]` section in `trac.ini`:
    37 
    38 [[TracIni(notification)]]
     37These are the available options for the `[notification]` section in trac.ini:
     38
     39[[TracIni(section=notification)]]
    3940
    4041=== Example Configuration (SMTP)
    41 
    4242{{{#!ini
    4343[notification]
    … …  
    5050
    5151=== Example Configuration (`sendmail`)
    52 
    5352{{{#!ini
    5453[notification]
    … …  
    6160}}}
    6261
    63 === Customizing the e-mail subject
    64 
    65 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:
    66 {{{
    67 $prefix #$ticket.id: $summary
    68 }}}
    69 
     62=== Subscriber Configuration
     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.
     68
     69For 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.
     70
     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:
     111{{{#!genshi
     112${prefix} #${ticket.id}: ${summary}
     113}}}
    70114The following variables are available in the template:
    71115
    72  * `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]).
    73118 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    74119 * `summary`: The ticket summary, with the old value if the summary was edited.
    75  * `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`.
    76 
    77 === Customizing the e-mail content
    78 
    79 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:
    80 
    81 {{{
    82 $ticket_body_hdr
    83 $ticket_props
    84 {% choose ticket.new %}\
    85 {%   when True %}\
    86 $ticket.description
    87 {%   end %}\
    88 {%   otherwise %}\
    89 {%     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:
    90133${_('Changes (by %(author)s):', author=change.author)}
    91134
    92 $changes_body
    93 {%     end %}\
    94 {%     if changes_descr %}\
    95 {%       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:
    96139${_('Description changed by %(author)s:', author=change.author)}
    97 {%       end %}\
    98 $changes_descr
     140#     endif
     141${changes_descr}
    99142--
    100 {%     end %}\
    101 {%     if change.comment %}\
    102 
    103 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
    104 
    105 $change.comment
    106 {%     end %}\
    107 {%   end %}\
    108 {% end %}\
    109 
    110 --
     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${'-- '}
    111153${_('Ticket URL: <%(link)s>', link=ticket.link)}
    112 $project.name <${project.url or abs_href()}>
    113 $project.descr
    114 }}}
     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.
    115159
    116160== Sample Email
    117 
    118161{{{
    119162#42: testing
    120163---------------------------+------------------------------------------------
    121        Id:  42             |      Status:  assigned               
     164       Id:  42             |      Status:  assigned
    122165Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
    123  Severity:  major          |   Milestone:  0.9                     
    124  Priority:  lowest         |     Version:  0.6                     
    125     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
    126169---------------------------+------------------------------------------------
    127170Changes:
    … …  
    141184}}}
    142185
    143 == Customizing e-mail content for MS Outlook
    144 
    145 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].
    146 
    147 Replace the following second row in the template:
    148 {{{
    149 $ticket_props
    150 }}}
    151 
    152 with this (requires Python 2.6 or later):
    153 {{{
    154 --------------------------------------------------------------------------
    155 {% with
    156    pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
    157          [c.strip() for c in
    158           ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
    159    sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
    160           'Component', 'Severity', 'Resolution', 'Keywords'] %}\
    161 ${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
    162 {% end %}\
    163 --------------------------------------------------------------------------
    164 }}}
    165 
    166 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.
    167 {{{#!div style="margin: 1em 1.75em; border:1px dotted"
    168 {{{#!html
    169 #42: testing<br />
    170 --------------------------------------------------------------------------<br />
    171 <table cellpadding=0>
    172 <tr><td>Reporter:</td><td>jonas@example.com</td></tr>
    173 <tr><td>Owner:</td><td>anonymous</td></tr>
    174 <tr><td>Type:</td><td>defect</td></tr>
    175 <tr><td>Status:</td><td>assigned</td></tr>
    176 <tr><td>Priority:</td><td>lowest</td></tr>
    177 <tr><td>Milestone:</td><td>0.9</td></tr>
    178 <tr><td>Component:</td><td>report system</td></tr>
    179 <tr><td>Severity:</td><td>major</td></tr>
    180 <tr><td>Resolution:</td><td> </td></tr>
    181 <tr><td>Keywords:</td><td> </td></tr>
    182 </table>
    183 --------------------------------------------------------------------------<br />
    184 Changes:<br />
    185 <br />
    186 &nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    187 &nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    188 &nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
    189 &nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
    190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
    191 &nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
    192 <br />
    193 Comment:<br />
    194 I'm interested too!<br />
    195 <br />
    196 --<br />
    197 Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
    198 My Project &lt;http://myproj.example.com/&gt;<br />
    199 }}}
    200 }}}
    201 
    202 **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:
    203 {{{
    204    sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    205 }}}
    206 
    207 However, the solution is still a workaround to an automatically HTML-formatted e-mail.
    208 
    209186== Using GMail as the SMTP relay host
    210187
    … …  
    221198}}}
    222199
    223 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].
    224201
    225202Alternatively, you can use `smtp_port = 25`.[[br]]
    226203You should not use `smtp_port = 465`. Doing so may deadlock your ticket submission. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [trac:comment:2:ticket:7107 #7107] for details.
    227  
    228 == Filtering notifications for one's own changes and comments
    229 
    230 To delete these notifications in Gmail, use the following filter:
    231 {{{
    232 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    233 }}}
    234 
    235 In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
    236 
    237 You can also add this plugin:
    238 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    239204
    240205== Troubleshooting
    241206
    242 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.
    243 
    244 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.
    245210
    246211=== ''Permission denied'' error
    247212
    248213Typical error message:
    249 {{{
     214{{{#!sh
    250215  ...
    251216  File ".../smtplib.py", line 303, in connect
    … …  
    260225telnet localhost 25
    261226}}}
    262 
    263227This is because a regular user may connect to the SMTP server, but the web server cannot:
    264228{{{#!sh
    … …  
    268232In such a case, you need to configure your server so that the web server is authorized to post to the SMTP server. The actual settings depend on your Linux distribution and current security policy. You may find help in the Trac [trac:MailingList MailingList] archive.
    269233
    270 Relevant mailing list thread on SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     234Relevant ML threads:
     235 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    271236
    272237For SELinux in Fedora 10:
    273238{{{#!sh
    274 setsebool -P httpd_can_sendmail 1
     239$ setsebool -P httpd_can_sendmail 1
    275240}}}
    276241