Changes between Initial Version and Version 1 of TracNotification


Ignore:
Timestamp:
Feb 7, 2016, 1:07:44 AM (22 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v1 v1  
     1= Email Notification of Ticket Changes =
     2[[TracGuideToc]]
     3
     4Trac supports notification of ticket changes via email.
     5
     6Email 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
     8Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
     9
     10== Receiving Notification Mails ==
     11When 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
     13This 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
     17To 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
     19Alternatively, 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.
     20
     21When 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`''').
     22
     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 ===
     28These are the available options for the `[notification]` section in trac.ini.
     29
     30[[TracIni(notification)]]
     31
     32=== Example Configuration (SMTP) ===
     33{{{
     34[notification]
     35smtp_enabled = true
     36smtp_server = mail.example.com
     37smtp_from = notifier@example.com
     38smtp_replyto = myproj@projects.example.com
     39smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     40}}}
     41
     42=== Example Configuration (`sendmail`) ===
     43{{{
     44[notification]
     45smtp_enabled = true
     46email_sender = SendmailEmailSender
     47sendmail_path = /usr/sbin/sendmail
     48smtp_from = notifier@example.com
     49smtp_replyto = myproj@projects.example.com
     50smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     51}}}
     52
     53=== Customizing the e-mail subject ===
     54The 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
     57}}}
     58The following variables are available in the template:
     59
     60 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     61 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     62 * `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
     67The 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 %}\
     78${_('Changes (by %(author)s):', author=change.author)}
     79
     80$changes_body
     81{%     end %}\
     82{%     if changes_descr %}\
     83{%       if not changes_body and not change.comment and change.author %}\
     84${_('Description changed by %(author)s:', author=change.author)}
     85{%       end %}\
     86$changes_descr
     87--
     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--
     99${_('Ticket URL: <%(link)s>', link=ticket.link)}
     100$project.name <${project.url or abs_href()}>
     101$project.descr
     102}}}
     103== Sample Email ==
     104{{{
     105#42: testing
     106---------------------------+------------------------------------------------
     107       Id:  42             |      Status:  assigned               
     108Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
     109 Severity:  major          |   Milestone:  0.9                     
     110 Priority:  lowest         |     Version:  0.6                     
     111    Owner:  anonymous      |    Reporter:  jonas@example.com               
     112---------------------------+------------------------------------------------
     113Changes:
     114  * component:  changset view => search system
     115  * priority:  low => highest
     116  * owner:  jonas => anonymous
     117  * cc:  daniel@example.com =>
     118         daniel@example.com, jonas@example.com
     119  * status:  new => assigned
     120
     121Comment:
     122I'm interested too!
     123
     124--
     125Ticket URL: <http://example.com/trac/ticket/42>
     126My Project <http://myproj.example.com/>
     127}}}
     128
     129
     130== Customizing e-mail content for MS Outlook ==
     131
     132Out-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
     134Replace the following second row in the template:
     135{{{
     136$ticket_props
     137}}}
     138
     139with 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
     153The 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 />
     171Changes:<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 />
     180Comment:<br />
     181I'm interested too!<br />
     182<br />
     183--<br />
     184Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     185My 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
     194However, 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
     199Use the following configuration snippet
     200{{{
     201[notification]
     202smtp_enabled = true
     203use_tls = true
     204mime_encoding = base64
     205smtp_server = smtp.gmail.com
     206smtp_port = 587
     207smtp_user = user
     208smtp_password = password
     209}}}
     210
     211where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     212
     213Alternatively, you can use `smtp_port = 25`.[[br]]
     214You 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 ==
     217In Gmail, use the filter:
     218
     219{{{
     220from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     221}}}
     222
     223to delete these notifications.
     224
     225In Thunderbird, there is no such solution if you use IMAP
     226(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
     227
     228You can also add this plugin:
     229http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
     230
     231== Troubleshooting ==
     232
     233If 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
     235Notification 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 ===
     238
     239Typical error message:
     240{{{
     241  ...
     242  File ".../smtplib.py", line 303, in connect
     243    raise socket.error, msg
     244  error: (13, 'Permission denied')
     245}}}
     246
     247This 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.
     248
     249Many users get confused when their manual attempts to contact the SMTP server succeed:
     250{{{
     251telnet localhost 25
     252}}}
     253The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
     254{{{
     255sudo -u www-data telnet localhost 25
     256}}}
     257
     258In 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.
     259
     260Relevant ML threads:
     261 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     262
     263For SELinux in Fedora 10:
     264{{{
     265$ setsebool -P httpd_can_sendmail 1
     266}}}
     267=== ''Suspected spam'' error ===
     268
     269Some SMTP servers may reject the notification email sent by Trac.
     270
     271The 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
     273Quoted 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
     277On IIS 6.0 you could get a
     278{{{
     279Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
     280}}}
     281in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
     282
     283
     284----
     285See also: TracTickets, TracIni, TracGuide