Changes between Initial Version and Version 1 of TracNotification


Ignore:
Timestamp:
09/09/2017 07:39:43 PM (7 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
     11
     12When 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.
     13
     14=== How to use your username to receive notification mails
     15
     16To 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.
     17
     18Alternatively, 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.
     19
     20When 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`''').
     21
     22=== Ticket attachment notifications
     23
     24Since 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:
     25{{{#!ini
     26[components]
     27trac.ticket.notification.TicketAttachmentNotifier = disabled
     28}}}
     29
     30== Configuring SMTP Notification
     31
     32'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
     33
     34=== Configuration Options
     35
     36These are the available options for the `[notification]` section in `trac.ini`:
     37
     38[[TracIni(notification)]]
     39
     40=== Example Configuration (SMTP)
     41
     42{{{#!ini
     43[notification]
     44smtp_enabled = true
     45smtp_server = mail.example.com
     46smtp_from = notifier@example.com
     47smtp_replyto = myproj@projects.example.com
     48smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     49}}}
     50
     51=== Example Configuration (`sendmail`)
     52
     53{{{#!ini
     54[notification]
     55smtp_enabled = true
     56email_sender = SendmailEmailSender
     57sendmail_path = /usr/sbin/sendmail
     58smtp_from = notifier@example.com
     59smtp_replyto = myproj@projects.example.com
     60smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     61}}}
     62
     63=== Customizing the e-mail subject
     64
     65The 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
     70The following variables are available in the template:
     71
     72 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     73 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     74 * `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`.
     76
     77=== Customizing the e-mail content
     78
     79The 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 %}\
     90${_('Changes (by %(author)s):', author=change.author)}
     91
     92$changes_body
     93{%     end %}\
     94{%     if changes_descr %}\
     95{%       if not changes_body and not change.comment and change.author %}\
     96${_('Description changed by %(author)s:', author=change.author)}
     97{%       end %}\
     98$changes_descr
     99--
     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--
     111${_('Ticket URL: <%(link)s>', link=ticket.link)}
     112$project.name <${project.url or abs_href()}>
     113$project.descr
     114}}}
     115
     116== Sample Email
     117
     118{{{
     119#42: testing
     120---------------------------+------------------------------------------------
     121       Id:  42             |      Status:  assigned               
     122Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
     123 Severity:  major          |   Milestone:  0.9                     
     124 Priority:  lowest         |     Version:  0.6                     
     125    Owner:  anonymous      |    Reporter:  jonas@example.com               
     126---------------------------+------------------------------------------------
     127Changes:
     128  * component:  changeset view => search system
     129  * priority:  low => highest
     130  * owner:  jonas => anonymous
     131  * cc:  daniel@example.com =>
     132         daniel@example.com, jonas@example.com
     133  * status:  new => assigned
     134
     135Comment:
     136I'm interested too!
     137
     138--
     139Ticket URL: <http://example.com/trac/ticket/42>
     140My Project <http://myproj.example.com/>
     141}}}
     142
     143== Customizing e-mail content for MS Outlook
     144
     145MS 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
     147Replace the following second row in the template:
     148{{{
     149$ticket_props
     150}}}
     151
     152with 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
     166The 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 />
     184Changes:<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 />
     193Comment:<br />
     194I'm interested too!<br />
     195<br />
     196--<br />
     197Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     198My 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
     207However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     208
     209== Using GMail as the SMTP relay host
     210
     211Use the following configuration snippet:
     212{{{#!ini
     213[notification]
     214smtp_enabled = true
     215use_tls = true
     216mime_encoding = base64
     217smtp_server = smtp.gmail.com
     218smtp_port = 587
     219smtp_user = user
     220smtp_password = password
     221}}}
     222
     223where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     224
     225Alternatively, you can use `smtp_port = 25`.[[br]]
     226You 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
     230To delete these notifications in Gmail, use the following filter:
     231{{{
     232from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     233}}}
     234
     235In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
     236
     237You can also add this plugin:
     238http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
     239
     240== Troubleshooting
     241
     242If 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
     244Notification 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.
     245
     246=== ''Permission denied'' error
     247
     248Typical error message:
     249{{{
     250  ...
     251  File ".../smtplib.py", line 303, in connect
     252    raise socket.error, msg
     253  error: (13, 'Permission denied')
     254}}}
     255
     256This 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.
     257
     258Many users get confused when their manual attempts to contact the SMTP server succeed:
     259{{{#!sh
     260telnet localhost 25
     261}}}
     262
     263This is because a regular user may connect to the SMTP server, but the web server cannot:
     264{{{#!sh
     265sudo -u www-data telnet localhost 25
     266}}}
     267
     268In 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.
     269
     270Relevant mailing list thread on SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     271
     272For SELinux in Fedora 10:
     273{{{#!sh
     274setsebool -P httpd_can_sendmail 1
     275}}}
     276
     277=== ''Suspected spam'' error
     278
     279Some SMTP servers may reject the notification email sent by Trac.
     280
     281The 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.
     282
     283Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
     284
     285----
     286See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]