Changes between Version 4 and Version 5 of TracNotification


Ignore:
Timestamp:
02/01/21 14:06:05 (17 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
     
    1616=== How to use your username to receive notification mails
    1717
    18 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].
    1919
    2020Alternatively, 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.
     
    3232== Configuring SMTP Notification
    3333
    34 '''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.
    3535
    3636=== Configuration Options
     
    6161
    6262=== Subscriber Configuration
    63 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.
    6464
    6565[[TracIni(section=notification-subscriber)]]
    6666
    67 Each user can override these defaults in his ''Notifications'' preferences.
     67Each user can override these defaults in their ''Notifications'' preferences.
    6868
    6969For 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.
    7070
    71 === Customizing the e-mail subject
    72 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:
     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{{{#!ini
     86[notification-subscriber]
     87always_notify_owner = TicketOwnerSubscriber
     88always_notify_owner.distributor = email
     89always_notify_owner.priority = 100
     90always_notify_owner.adverb = always
     91always_notify_owner.format = text/plain
     92
     93always_notify_previous_updater = TicketPreviousUpdatersSubscriber
     94
     95never_notify_updater = TicketUpdaterSubscriber
     96never_notify_updater.adverb = never
     97never_notify_updater.priority = 0
     98
     99notify_cc_html = CarbonCopySubscriber
     100notify_cc_html.format = text/html
     101}}}
     102
     103=== Customizing the email subject
     104The 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:
    73105{{{#!genshi
    74106${prefix} #${ticket.id}: ${summary}
     
    76108The following variables are available in the template:
    77109
    78  * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]). 
     110 * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]).
    79111 * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]).
    80112 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    81113 * `summary`: The ticket summary, with the old value if the summary was edited.
    82  * `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`.
    83 
    84 === Customizing the e-mail content
    85 
    86 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:
    87 
    88 {{{#!genshi
    89 $ticket_body_hdr
    90 $ticket_props
    91 {% choose ticket.new %}\
    92 {%   when True %}\
    93 $ticket.description
    94 {%   end %}\
    95 {%   otherwise %}\
    96 {%     if changes_body %}\
     114 * `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}`.
     115
     116=== Customizing the email content #CustomizingContent
     117
     118The 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:
     119
     120{{{#!jinja
     121${ticket_body_hdr}
     122${ticket_props}
     123# if ticket.new:
     124${ticket.description}
     125# else:
     126#   if changes_body:
    97127${_('Changes (by %(author)s):', author=change.author)}
    98128
    99 $changes_body
    100 {%     end %}\
    101 {%     if changes_descr %}\
    102 {%       if not changes_body and not change.comment and change.author %}\
     129${changes_body}
     130#   endif
     131#   if changes_descr:
     132#     if not changes_body and not change.comment and change.author:
    103133${_('Description changed by %(author)s:', author=change.author)}
    104 {%       end %}\
    105 $changes_descr
     134#     endif
     135${changes_descr}
    106136--
    107 {%     end %}\
    108 {%     if change.comment %}\
    109 
    110 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
    111 
    112 $change.comment
    113 {%     end %}\
    114 {%   end %}\
    115 {% end %}\
    116 
    117 --
     137#   endif
     138#   if change.comment:
     139
     140${_('Comment:') if changes_body else
     141  _('Comment (by %(author)s):', author=change.author)}
     142
     143${change.comment}
     144#   endif
     145# endif
     146${'-- '}
    118147${_('Ticket URL: <%(link)s>', link=ticket.link)}
    119 $project.name <${project.url or abs_href()}>
    120 $project.descr
    121 }}}
     148${project.name} <${project.url or abs_href()}>
     149${project.descr}
     150}}}
     151
     152See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
    122153
    123154== Sample Email
     
    125156#42: testing
    126157---------------------------+------------------------------------------------
    127        Id:  42             |      Status:  assigned               
     158       Id:  42             |      Status:  assigned
    128159Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
    129  Severity:  major          |   Milestone:  0.9                     
    130  Priority:  lowest         |     Version:  0.6                     
    131     Owner:  anonymous      |    Reporter:  jonas@example.com               
     160 Severity:  major          |   Milestone:  0.9
     161 Priority:  lowest         |     Version:  0.6
     162    Owner:  anonymous      |    Reporter:  jonas@example.com
    132163---------------------------+------------------------------------------------
    133164Changes:
     
    147178}}}
    148179
    149 == Customizing e-mail content for MS Outlook
    150 
    151 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].
    152 
    153 Replace the following second row in the template:
    154 {{{
    155 $ticket_props
    156 }}}
    157 
    158 with this (requires Python 2.6 or later):
    159 {{{
    160 --------------------------------------------------------------------------
    161 {% with
    162    pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
    163          [c.strip() for c in
    164           ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
    165    sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
    166           'Component', 'Severity', 'Resolution', 'Keywords'] %}\
    167 ${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
    168 {% end %}\
    169 --------------------------------------------------------------------------
    170 }}}
    171 
    172 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.
    173 {{{#!div style="margin: 1em 1.75em; border:1px dotted"
    174 {{{#!html
    175 #42: testing<br />
    176 --------------------------------------------------------------------------<br />
    177 <table cellpadding=0>
    178 <tr><td>Reporter:</td><td>jonas@example.com</td></tr>
    179 <tr><td>Owner:</td><td>anonymous</td></tr>
    180 <tr><td>Type:</td><td>defect</td></tr>
    181 <tr><td>Status:</td><td>assigned</td></tr>
    182 <tr><td>Priority:</td><td>lowest</td></tr>
    183 <tr><td>Milestone:</td><td>0.9</td></tr>
    184 <tr><td>Component:</td><td>report system</td></tr>
    185 <tr><td>Severity:</td><td>major</td></tr>
    186 <tr><td>Resolution:</td><td> </td></tr>
    187 <tr><td>Keywords:</td><td> </td></tr>
    188 </table>
    189 --------------------------------------------------------------------------<br />
    190 Changes:<br />
    191 <br />
    192 &nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    193 &nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    194 &nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
    195 &nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
    196 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
    197 &nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
    198 <br />
    199 Comment:<br />
    200 I'm interested too!<br />
    201 <br />
    202 --<br />
    203 Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
    204 My Project &lt;http://myproj.example.com/&gt;<br />
    205 }}}
    206 }}}
    207 
    208 **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:
    209 {{{
    210    sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    211 }}}
    212 
    213 However, the solution is still a workaround to an automatically HTML-formatted e-mail.
    214 
    215180== Using GMail as the SMTP relay host
    216181
     
    227192}}}
    228193
    229 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     194where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com].
    230195
    231196Alternatively, you can use `smtp_port = 25`.[[br]]
     
    234199== Troubleshooting
    235200
    236 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.
    237 
    238 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.
     201If notifications are not working, inspect the [TracLogging log] for error messages.
     202
     203Notification 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.
    239204
    240205=== ''Permission denied'' error