Changes between Version 8 and Version 9 of TracNotification


Ignore:
Timestamp:
10/02/17 20:17:00 (3 weeks 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
    11 
    1211When 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.
    1312
    1413=== How to use your username to receive notification mails
    1514
    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.
     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].
    1716
    1817Alternatively, 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.
     
    3029== Configuring SMTP Notification
    3130
    32 '''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.
    3332
    3433=== Configuration Options
    35 
    36 These are the available options for the `[notification]` section in `trac.ini`:
    37 
    38 [[TracIni(notification)]]
     34These are the available options for the `[notification]` section in trac.ini:
     35
     36[[TracIni(section=notification)]]
    3937
    4038=== Example Configuration (SMTP)
    41 
    4239{{{#!ini
    4340[notification]
     
    5047
    5148=== Example Configuration (`sendmail`)
    52 
    5349{{{#!ini
    5450[notification]
     
    6157}}}
    6258
     59=== Subscriber Configuration
     60The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
     61
     62[[TracIni(section=notification-subscriber)]]
     63
     64Each user can override these defaults in their ''Notifications'' preferences.
     65
     66For 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.
     67
     68The 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.
     69
     70The following attributes of default subscriptions can be configured:
     71* `.distributor` (Default: `email`)
     72  * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.
     73* `.priority` (Default: `100`)
     74  * Smaller values override larger values.
     75  * If you use `0`, then users will not be able to override this rule.
     76* `.adverb` (Default: `always`)
     77  * `never` can be used to silence other subscription rules with higher values.
     78* `.format` (Default: `text/plain`)
     79  * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.
     80
     81=== Example Configuration (default subscriptions)
     82{{{#!ini
     83[notification-subscriber]
     84always_notify_owner = TicketOwnerSubscriber
     85always_notify_owner.distributor = email
     86always_notify_owner.priority = 100
     87always_notify_owner.adverb = always
     88always_notify_owner.format = text/plain
     89
     90always_notify_previous_updater = TicketPreviousUpdatersSubscriber
     91
     92never_notify_updater = TicketUpdaterSubscriber
     93never_notify_updater.adverb = never
     94never_notify_updater.priority = 0
     95
     96notify_cc_html = CarbonCopySubscriber
     97notify_cc_html.format = text/html
     98}}}
     99
    63100=== Customizing the e-mail subject
    64 
    65101The 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 
     102{{{#!genshi
     103${prefix} #${ticket.id}: ${summary}
     104}}}
    70105The following variables are available in the template:
    71106
    72  * `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]).
    73108 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    74109 * `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`.
     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}`.
    76111
    77112=== Customizing the e-mail content
    78113
    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 %}\
     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:
     115
     116{{{#!genshi
     117${ticket_body_hdr}
     118${ticket_props}
     119# if ticket.new:
     120${ticket.description}
     121# else:
     122#   if changes_body:
    90123${_('Changes (by %(author)s):', author=change.author)}
    91124
    92 $changes_body
    93 {%     end %}\
    94 {%     if changes_descr %}\
    95 {%       if not changes_body and not change.comment and change.author %}\
     125${changes_body}
     126#   endif
     127#   if changes_descr:
     128#     if not changes_body and not change.comment and change.author:
    96129${_('Description changed by %(author)s:', author=change.author)}
    97 {%       end %}\
    98 $changes_descr
     130#     endif
     131${changes_descr}
    99132--
    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 --
     133#   endif
     134#   if change.comment:
     135
     136${_('Comment:') if changes_body else
     137  _('Comment (by %(author)s):', author=change.author)}
     138
     139${change.comment}
     140#   endif
     141# endif
     142--
    111143${_('Ticket URL: <%(link)s>', link=ticket.link)}
    112 $project.name <${project.url or abs_href()}>
    113 $project.descr
    114 }}}
     144${project.name} <${project.url or abs_href()}>
     145${project.descr}
     146}}}
     147
     148See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
    115149
    116150== Sample Email
    117 
    118151{{{
    119152#42: testing
     
    141174}}}
    142175
    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 
    209176== Using GMail as the SMTP relay host
    210177
     
    225192Alternatively, you can use `smtp_port = 25`.[[br]]
    226193You 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.
    239194
    240195== Troubleshooting
    241196
    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.
     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.
    245200
    246201=== ''Permission denied'' error
    247202
    248203Typical error message:
    249 {{{
     204{{{#!sh
    250205  ...
    251206  File ".../smtplib.py", line 303, in connect
     
    260215telnet localhost 25
    261216}}}
    262 
    263217This is because a regular user may connect to the SMTP server, but the web server cannot:
    264218{{{#!sh
     
    268222In 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.
    269223
    270 Relevant mailing list thread on SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     224Relevant ML threads:
     225 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    271226
    272227For SELinux in Fedora 10:
    273228{{{#!sh
    274 setsebool -P httpd_can_sendmail 1
     229$ setsebool -P httpd_can_sendmail 1
    275230}}}
    276231