Changes between Version 2 and Version 3 of TracNotification


Ignore:
Timestamp:
May 26, 2018, 6:07:36 PM (18 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v2 v3  
    1 = Email Notification of Ticket Changes =
     1= Email Notification of Ticket Changes
    22[[TracGuideToc]]
    33
    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].
    9 
    10 == Receiving Notification Mails ==
    11 When reporting a new ticket or adding a comment, enter a valid email address or your 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).
    12 
    13 This is useful to keep up-to-date on an issue or enhancement request that interests you.
    14 
    15 === How to use your username to receive notification mails ===
    16 
    17 To receive notification mails, you can either enter a full email address or your username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page.
    18 
    19 Alternatively, 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.
     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].
     9
     10== Receiving Notification Mails
     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 will automatically send you an email when changes are made to the ticket, depending on how notification is configured.
     12
     13=== How to use your username to receive notification mails
     14
     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].
     16
     17Alternatively, 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.
    2018
    2119When using apache and mod_kerb for authentication against Kerberos / Active Directory, usernames take the form ('''`username@EXAMPLE.LOCAL`'''). To avoid this being interpreted as an email address, add the Kerberos domain to  ('''`ignore_domains`''').
    2220
    23 == Configuring SMTP Notification ==
    24 
    25 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    26 
    27 === Configuration Options ===
    28 These are the available options for the `[notification]` section in trac.ini.
    29 
    30 [[TracIni(notification)]]
    31 
    32 === Example Configuration (SMTP) ===
    33 {{{
     21=== Ticket attachment notifications
     22
     23Since 1.0.3 Trac will send notifications when a ticket attachment is added or deleted. Usually attachment notifications will be enabled in an environment by default. To disable the attachment notifications for an environment the `TicketAttachmentNotifier` component must be disabled:
     24{{{#!ini
     25[components]
     26trac.ticket.notification.TicketAttachmentNotifier = disabled
     27}}}
     28
     29== Configuring SMTP Notification
     30
     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.
     32
     33=== Configuration Options
     34These are the available options for the `[notification]` section in trac.ini:
     35
     36[[TracIni(section=notification)]]
     37
     38=== Example Configuration (SMTP)
     39{{{#!ini
    3440[notification]
    3541smtp_enabled = true
     
    4046}}}
    4147
    42 === Example Configuration (`sendmail`) ===
    43 {{{
     48=== Example Configuration (`sendmail`)
     49{{{#!ini
    4450[notification]
    4551smtp_enabled = true
     
    5157}}}
    5258
    53 === Customizing the e-mail subject ===
     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
     100=== Customizing the e-mail subject
    54101The 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:
    55 {{{
    56 $prefix #$ticket.id: $summary
     102{{{#!genshi
     103${prefix} #${ticket.id}: ${summary}
    57104}}}
    58105The following variables are available in the template:
    59106
    60  * `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]).
    61108 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    62109 * `summary`: The ticket summary, with the old value if the summary was edited.
    63  * `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, e.g. `$ticket.milestone`.
    64 
    65 === Customizing the e-mail content ===
    66 
    67 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:
    68 
    69 {{{
    70 $ticket_body_hdr
    71 $ticket_props
    72 {% choose ticket.new %}\
    73 {%   when True %}\
    74 $ticket.description
    75 {%   end %}\
    76 {%   otherwise %}\
    77 {%     if changes_body %}\
     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}`.
     111
     112=== Customizing the e-mail content
     113
     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:
    78123${_('Changes (by %(author)s):', author=change.author)}
    79124
    80 $changes_body
    81 {%     end %}\
    82 {%     if changes_descr %}\
    83 {%       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:
    84129${_('Description changed by %(author)s:', author=change.author)}
    85 {%       end %}\
    86 $changes_descr
     130#     endif
     131${changes_descr}
    87132--
    88 {%     end %}\
    89 {%     if change.comment %}\
    90 
    91 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
    92 
    93 $change.comment
    94 {%     end %}\
    95 {%   end %}\
    96 {% end %}\
    97 
    98 --
     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--
    99143${_('Ticket URL: <%(link)s>', link=ticket.link)}
    100 $project.name <${project.url or abs_href()}>
    101 $project.descr
    102 }}}
    103 == Sample Email ==
     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.
     149
     150== Sample Email
    104151{{{
    105152#42: testing
     
    112159---------------------------+------------------------------------------------
    113160Changes:
    114   * component:  changset view => search system
     161  * component:  changeset view => search system
    115162  * priority:  low => highest
    116163  * owner:  jonas => anonymous
     
    127174}}}
    128175
    129 
    130 == Customizing e-mail content for MS Outlook ==
    131 
    132 Out-of-the-box, MS Outlook normally presents plain text e-mails with a variable-width font; 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].
    133 
    134 Replace the following second row in the template:
    135 {{{
    136 $ticket_props
    137 }}}
    138 
    139 with this instead (''requires Python 2.6 or later''):
    140 {{{
    141 --------------------------------------------------------------------------
    142 {% with
    143    pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
    144          [c.strip() for c in
    145           ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
    146    sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
    147           'Component', 'Severity', 'Resolution', 'Keywords'] %}\
    148 ${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
    149 {% end %}\
    150 --------------------------------------------------------------------------
    151 }}}
    152 
    153 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.
    154 {{{#!div style="margin: 1em 1.75em; border:1px dotted"
    155 {{{#!html
    156 #42: testing<br />
    157 --------------------------------------------------------------------------<br />
    158 <table cellpadding=0>
    159 <tr><td>Reporter:</td><td>jonas@example.com</td></tr>
    160 <tr><td>Owner:</td><td>anonymous</td></tr>
    161 <tr><td>Type:</td><td>defect</td></tr>
    162 <tr><td>Status:</td><td>assigned</td></tr>
    163 <tr><td>Priority:</td><td>lowest</td></tr>
    164 <tr><td>Milestone:</td><td>0.9</td></tr>
    165 <tr><td>Component:</td><td>report system</td></tr>
    166 <tr><td>Severity:</td><td>major</td></tr>
    167 <tr><td>Resolution:</td><td> </td></tr>
    168 <tr><td>Keywords:</td><td> </td></tr>
    169 </table>
    170 --------------------------------------------------------------------------<br />
    171 Changes:<br />
    172 <br />
    173 &nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
    174 &nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    175 &nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
    176 &nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
    177 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
    178 &nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
    179 <br />
    180 Comment:<br />
    181 I'm interested too!<br />
    182 <br />
    183 --<br />
    184 Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
    185 My Project &lt;http://myproj.example.com/&gt;<br />
    186 }}}
    187 }}}
    188 
    189 **Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which shall be part of the mail they have to be added to `sel`, example:
    190 {{{
    191    sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    192 }}}
    193 
    194 However, it's not as perfect as an automatically HTML-formatted e-mail would be, but presented ticket properties are at least readable by default in MS Outlook...
    195 
    196 
    197 == Using GMail as the SMTP relay host ==
    198 
    199 Use the following configuration snippet
    200 {{{
     176== Using GMail as the SMTP relay host
     177
     178Use the following configuration snippet:
     179{{{#!ini
    201180[notification]
    202181smtp_enabled = true
     
    209188}}}
    210189
    211 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     190where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
    212191
    213192Alternatively, you can use `smtp_port = 25`.[[br]]
    214 You should not use `smtp_port = 465`. It will not work and your ticket submission may deadlock. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [trac:comment:2:ticket:7107 #7107] for details.
    215  
    216 == Filtering notifications for one's own changes and comments ==
    217 In Gmail, use the filter:
    218 
    219 {{{
    220 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    221 }}}
    222 
    223 to delete these notifications.
    224 
    225 In Thunderbird, there is no such solution if you use IMAP
    226 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
    227 
    228 You can also add this plugin:
    229 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    230 
    231 == Troubleshooting ==
    232 
    233 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.
    234 
    235 Notification errors are not reported through the web interface, so the user who submit 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.
    236 
    237 === ''Permission denied'' error ===
     193You 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.
     194
     195== Troubleshooting
     196
     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.
     200
     201=== ''Permission denied'' error
    238202
    239203Typical error message:
    240 {{{
     204{{{#!sh
    241205  ...
    242206  File ".../smtplib.py", line 303, in connect
     
    245209}}}
    246210
    247 This error usually comes from a security settings on the server: many Linux distributions do not let the web server (Apache, ...) to post email message to the local SMTP server.
     211This error usually comes from a security settings on the server: many Linux distributions do not allow the web server (Apache, ...) to post email messages to the local SMTP server.
    248212
    249213Many users get confused when their manual attempts to contact the SMTP server succeed:
    250 {{{
     214{{{#!sh
    251215telnet localhost 25
    252216}}}
    253 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    254 {{{
     217This is because a regular user may connect to the SMTP server, but the web server cannot:
     218{{{#!sh
    255219sudo -u www-data telnet localhost 25
    256220}}}
    257221
    258 In 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 browsing the Trac [trac:MailingList MailingList] archive.
     222In 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.
    259223
    260224Relevant ML threads:
     
    262226
    263227For SELinux in Fedora 10:
    264 {{{
     228{{{#!sh
    265229$ setsebool -P httpd_can_sendmail 1
    266230}}}
    267 === ''Suspected spam'' error ===
     231
     232=== ''Suspected spam'' error
    268233
    269234Some SMTP servers may reject the notification email sent by Trac.
    270235
    271 The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger ''false positive'' SPAM detection on sensitive email servers. In such an event, it is recommended to change the default encoding to "quoted-printable" using the `mime_encoding` option.
    272 
    273 Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended to stick with the Base64 encoding.
    274 
    275 === ''501, 5.5.4 Invalid Address'' error ===
    276 
    277 On IIS 6.0 you could get a
    278 {{{
    279 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
    280 }}}
    281 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
    282 
     236The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger ''false positive'' spam detection on sensitive email servers. In such an event, change the default encoding to "quoted-printable" using the `mime_encoding` option.
     237
     238Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    283239
    284240----
    285 See also: TracTickets, TracIni, TracGuide
     241See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]