Changes between Initial Version and Version 1 of TracNotification


Ignore:
Timestamp:
08/07/15 22:11:27 (5 years 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 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 the ''Preferences'' page.
     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.
     18
     19When 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`''').
     20
     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:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
     32
     33=== Configuration Options ===
     34These are the available options for the `[notification]` section in trac.ini:
     35
     36[[TracIni(notification)]]
     37
     38=== Example Configuration (SMTP) ===
     39{{{
     40[notification]
     41smtp_enabled = true
     42smtp_server = mail.example.com
     43smtp_from = notifier@example.com
     44smtp_replyto = myproj@projects.example.com
     45smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     46}}}
     47
     48=== Example Configuration (`sendmail`) ===
     49{{{
     50[notification]
     51smtp_enabled = true
     52email_sender = SendmailEmailSender
     53sendmail_path = /usr/sbin/sendmail
     54smtp_from = notifier@example.com
     55smtp_replyto = myproj@projects.example.com
     56smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     57}}}
     58
     59=== Customizing the e-mail subject ===
     60The 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:
     61{{{
     62$prefix #$ticket.id: $summary
     63}}}
     64The following variables are available in the template:
     65
     66 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     67 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     68 * `summary`: The ticket summary, with the old value if the summary was edited.
     69 * `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`.
     70
     71=== Customizing the e-mail content ===
     72
     73The 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:
     74
     75{{{
     76$ticket_body_hdr
     77$ticket_props
     78{% choose ticket.new %}\
     79{%   when True %}\
     80$ticket.description
     81{%   end %}\
     82{%   otherwise %}\
     83{%     if changes_body %}\
     84${_('Changes (by %(author)s):', author=change.author)}
     85
     86$changes_body
     87{%     end %}\
     88{%     if changes_descr %}\
     89{%       if not changes_body and not change.comment and change.author %}\
     90${_('Description changed by %(author)s:', author=change.author)}
     91{%       end %}\
     92$changes_descr
     93--
     94{%     end %}\
     95{%     if change.comment %}\
     96
     97${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     98
     99$change.comment
     100{%     end %}\
     101{%   end %}\
     102{% end %}\
     103
     104--
     105${_('Ticket URL: <%(link)s>', link=ticket.link)}
     106$project.name <${project.url or abs_href()}>
     107$project.descr
     108}}}
     109
     110== Sample Email ==
     111{{{
     112#42: testing
     113---------------------------+------------------------------------------------
     114       Id:  42             |      Status:  assigned               
     115Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
     116 Severity:  major          |   Milestone:  0.9                     
     117 Priority:  lowest         |     Version:  0.6                     
     118    Owner:  anonymous      |    Reporter:  jonas@example.com               
     119---------------------------+------------------------------------------------
     120Changes:
     121  * component:  changeset view => search system
     122  * priority:  low => highest
     123  * owner:  jonas => anonymous
     124  * cc:  daniel@example.com =>
     125         daniel@example.com, jonas@example.com
     126  * status:  new => assigned
     127
     128Comment:
     129I'm interested too!
     130
     131--
     132Ticket URL: <http://example.com/trac/ticket/42>
     133My Project <http://myproj.example.com/>
     134}}}
     135
     136== Customizing e-mail content for MS Outlook ==
     137
     138MS 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].
     139
     140Replace the following second row in the template:
     141{{{
     142$ticket_props
     143}}}
     144
     145with this (requires Python 2.6 or later):
     146{{{
     147--------------------------------------------------------------------------
     148{% with
     149   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     150         [c.strip() for c in
     151          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     152   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     153          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     154${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     155{% end %}\
     156--------------------------------------------------------------------------
     157}}}
     158
     159The 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.
     160{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     161{{{#!html
     162#42: testing<br />
     163--------------------------------------------------------------------------<br />
     164<table cellpadding=0>
     165<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     166<tr><td>Owner:</td><td>anonymous</td></tr>
     167<tr><td>Type:</td><td>defect</td></tr>
     168<tr><td>Status:</td><td>assigned</td></tr>
     169<tr><td>Priority:</td><td>lowest</td></tr>
     170<tr><td>Milestone:</td><td>0.9</td></tr>
     171<tr><td>Component:</td><td>report system</td></tr>
     172<tr><td>Severity:</td><td>major</td></tr>
     173<tr><td>Resolution:</td><td> </td></tr>
     174<tr><td>Keywords:</td><td> </td></tr>
     175</table>
     176--------------------------------------------------------------------------<br />
     177Changes:<br />
     178<br />
     179&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     180&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     181&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     182&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     184&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     185<br />
     186Comment:<br />
     187I'm interested too!<br />
     188<br />
     189--<br />
     190Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     191My Project &lt;http://myproj.example.com/&gt;<br />
     192}}}
     193}}}
     194
     195**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:
     196{{{
     197   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     198}}}
     199
     200However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     201
     202== Using GMail as the SMTP relay host ==
     203
     204Use the following configuration snippet:
     205{{{
     206[notification]
     207smtp_enabled = true
     208use_tls = true
     209mime_encoding = base64
     210smtp_server = smtp.gmail.com
     211smtp_port = 587
     212smtp_user = user
     213smtp_password = password
     214}}}
     215
     216where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     217
     218Alternatively, you can use `smtp_port = 25`.[[br]]
     219You 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.
     220 
     221== Filtering notifications for one's own changes and comments ==
     222In Gmail, use the filter:
     223{{{
     224from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     225}}}
     226
     227to delete these notifications.
     228
     229In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
     230
     231You can also add this plugin:
     232http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
     233
     234== Troubleshooting ==
     235
     236If 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
     238Notification 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.
     239
     240=== ''Permission denied'' error ===
     241
     242Typical error message:
     243{{{
     244  ...
     245  File ".../smtplib.py", line 303, in connect
     246    raise socket.error, msg
     247  error: (13, 'Permission denied')
     248}}}
     249
     250This 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.
     251
     252Many users get confused when their manual attempts to contact the SMTP server succeed:
     253{{{
     254telnet localhost 25
     255}}}
     256This is because a regular user may connect to the SMTP server, but the web server cannot:
     257{{{
     258sudo -u www-data telnet localhost 25
     259}}}
     260
     261In 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.
     262
     263Relevant ML threads:
     264 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     265
     266For SELinux in Fedora 10:
     267{{{
     268$ setsebool -P httpd_can_sendmail 1
     269}}}
     270
     271=== ''Suspected spam'' error ===
     272
     273Some SMTP servers may reject the notification email sent by Trac.
     274
     275The 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.
     276
     277Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
     278
     279----
     280See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]