Changes between Version 8 and Version 9 of TracNotification


Ignore:
Timestamp:
22/06/2017 14:04:09 (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v8 v9  
    44Trac supports notification of ticket changes via email.
    55
    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].
     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
    … …  
    1313=== How to use your username to receive notification mails
    1414
    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.
     15To 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].
    1616
    1717Alternatively, 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.
    … …  
    2929== Configuring SMTP Notification
    3030
    31 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
     31'''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated.
    3232
    3333=== Configuration Options
    … …  
    5858
    5959=== Subscriber Configuration
    60 The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
     60The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
    6161
    6262[[TracIni(section=notification-subscriber)]]
    6363
    64 Each user can override these defaults in his ''Notifications'' preferences.
     64Each user can override these defaults in their ''Notifications'' preferences.
    6565
    6666For 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.
    … …  
    105105The following variables are available in the template:
    106106
    107  * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     107 * `env`: The project environment object (see [trac:source:/trunk/trac/env.py env.py]).
    108108 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    109109 * `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}`.
     110 * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/model.py model.py]). Individual ticket fields can be accessed by appending the field name separated by a dot, eg `${ticket.milestone}`.
    111111
    112112=== Customizing the e-mail content
    113113
    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:
     114The 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 is:
    115115
    116116{{{#!genshi
    117117${ticket_body_hdr}
    118118${ticket_props}
    119 {% choose ticket.new %}\
    120 {%   when True %}\
     119# if ticket.new:
    121120${ticket.description}
    122 {%   end %}\
    123 {%   otherwise %}\
    124 {%     if changes_body %}\
     121# else:
     122#   if changes_body:
    125123${_('Changes (by %(author)s):', author=change.author)}
    126124
    127125${changes_body}
    128 {%     end %}\
    129 {%     if changes_descr %}\
    130 {%       if not changes_body and not change.comment and change.author %}\
     126#   endif
     127#   if changes_descr:
     128#     if not changes_body and not change.comment and change.author:
    131129${_('Description changed by %(author)s:', author=change.author)}
    132 {%       end %}\
     130#     endif
    133131${changes_descr}
    134132--
    135 {%     end %}\
    136 {%     if change.comment %}\
    137 
    138 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     133#   endif
     134#   if change.comment:
     135
     136${_('Comment:') if changes_body else
     137  _('Comment (by %(author)s):', author=change.author)}
    139138
    140139${change.comment}
    141 {%     end %}\
    142 {%   end %}\
    143 {% end %}\
    144 
    145 --
     140#   endif
     141# endif
     142--
    146143${_('Ticket URL: <%(link)s>', link=ticket.link)}
    147144${project.name} <${project.url or abs_href()}>
    148145${project.descr}
    149146}}}
     147
     148See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
    150149
    151150== Sample Email
    … …  
    175174}}}
    176175
    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 
    243176== Using GMail as the SMTP relay host
    244177
    … …  
    262195== Troubleshooting
    263196
    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.
     197If notifications are not working, inspect the [TracLogging log] for error messages.
     198
     199Notification 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.
    267200
    268201=== ''Permission denied'' error