Edgewall Software

Changes between Initial Version and Version 1 of 1.3/TracNotification


Ignore:
Timestamp:
Jul 3, 2016, 12:42:07 AM (3 years ago)
Author:
Ryan J Ollos
Comment:

Copied from 1.1/TracNotification@3.

Legend:

Unmodified
Added
Removed
Modified
  • 1.3/TracNotification

    v1 v1  
     1= Email Notification of Ticket Changes
     2[[TracGuideToc]]
     3[[TranslatedPages]]
     4
     5Trac supports notification of ticket changes via email.
     6
     7Email 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.
     8
     9Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
     10
     11== Receiving Notification Mails
     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
     35These are the available options for the `[notification]` section in trac.ini:
     36
     37[[TracIni(notification)]]
     38
     39=== Example Configuration (SMTP)
     40{{{#!ini
     41[notification]
     42smtp_enabled = true
     43smtp_server = mail.example.com
     44smtp_from = notifier@example.com
     45smtp_replyto = myproj@projects.example.com
     46smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     47}}}
     48
     49=== Example Configuration (`sendmail`)
     50{{{#!ini
     51[notification]
     52smtp_enabled = true
     53email_sender = SendmailEmailSender
     54sendmail_path = /usr/sbin/sendmail
     55smtp_from = notifier@example.com
     56smtp_replyto = myproj@projects.example.com
     57smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     58}}}
     59
     60=== Subscriber Configuration
     61The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
     62
     63[[TracIni(notification-subscriber)]]
     64
     65Each user can override these defaults in his ''Notifications'' preferences.
     66
     67For 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.
     68
     69=== Customizing the e-mail subject
     70The 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:
     71{{{#!genshi
     72$prefix #$ticket.id: $summary
     73}}}
     74The following variables are available in the template:
     75
     76 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     77 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     78 * `summary`: The ticket summary, with the old value if the summary was edited.
     79 * `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`.
     80
     81=== Customizing the e-mail content
     82
     83The 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:
     84
     85{{{#!genshi
     86$ticket_body_hdr
     87$ticket_props
     88{% choose ticket.new %}\
     89{%   when True %}\
     90$ticket.description
     91{%   end %}\
     92{%   otherwise %}\
     93{%     if changes_body %}\
     94${_('Changes (by %(author)s):', author=change.author)}
     95
     96$changes_body
     97{%     end %}\
     98{%     if changes_descr %}\
     99{%       if not changes_body and not change.comment and change.author %}\
     100${_('Description changed by %(author)s:', author=change.author)}
     101{%       end %}\
     102$changes_descr
     103--
     104{%     end %}\
     105{%     if change.comment %}\
     106
     107${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     108
     109$change.comment
     110{%     end %}\
     111{%   end %}\
     112{% end %}\
     113
     114--
     115${_('Ticket URL: <%(link)s>', link=ticket.link)}
     116$project.name <${project.url or abs_href()}>
     117$project.descr
     118}}}
     119
     120== Sample Email
     121{{{
     122#42: testing
     123---------------------------+------------------------------------------------
     124       Id:  42             |      Status:  assigned               
     125Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
     126 Severity:  major          |   Milestone:  0.9                     
     127 Priority:  lowest         |     Version:  0.6                     
     128    Owner:  anonymous      |    Reporter:  jonas@example.com               
     129---------------------------+------------------------------------------------
     130Changes:
     131  * component:  changeset view => search system
     132  * priority:  low => highest
     133  * owner:  jonas => anonymous
     134  * cc:  daniel@example.com =>
     135         daniel@example.com, jonas@example.com
     136  * status:  new => assigned
     137
     138Comment:
     139I'm interested too!
     140
     141--
     142Ticket URL: <http://example.com/trac/ticket/42>
     143My Project <http://myproj.example.com/>
     144}}}
     145
     146== Customizing e-mail content for MS Outlook
     147
     148MS 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].
     149
     150Replace the following second row in the template:
     151{{{
     152$ticket_props
     153}}}
     154
     155with this (requires Python 2.6 or later):
     156{{{
     157--------------------------------------------------------------------------
     158{% with
     159   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     160         [c.strip() for c in
     161          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     162   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     163          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     164${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     165{% end %}\
     166--------------------------------------------------------------------------
     167}}}
     168
     169The 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.
     170{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     171{{{#!html
     172#42: testing<br />
     173--------------------------------------------------------------------------<br />
     174<table cellpadding=0>
     175<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     176<tr><td>Owner:</td><td>anonymous</td></tr>
     177<tr><td>Type:</td><td>defect</td></tr>
     178<tr><td>Status:</td><td>assigned</td></tr>
     179<tr><td>Priority:</td><td>lowest</td></tr>
     180<tr><td>Milestone:</td><td>0.9</td></tr>
     181<tr><td>Component:</td><td>report system</td></tr>
     182<tr><td>Severity:</td><td>major</td></tr>
     183<tr><td>Resolution:</td><td> </td></tr>
     184<tr><td>Keywords:</td><td> </td></tr>
     185</table>
     186--------------------------------------------------------------------------<br />
     187Changes:<br />
     188<br />
     189&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     190&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     191&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     192&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     194&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     195<br />
     196Comment:<br />
     197I'm interested too!<br />
     198<br />
     199--<br />
     200Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     201My Project &lt;http://myproj.example.com/&gt;<br />
     202}}}
     203}}}
     204
     205**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:
     206{{{
     207   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     208}}}
     209
     210However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     211
     212== Using GMail as the SMTP relay host
     213
     214Use the following configuration snippet:
     215{{{#!ini
     216[notification]
     217smtp_enabled = true
     218use_tls = true
     219mime_encoding = base64
     220smtp_server = smtp.gmail.com
     221smtp_port = 587
     222smtp_user = user
     223smtp_password = password
     224}}}
     225
     226where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     227
     228Alternatively, you can use `smtp_port = 25`.[[br]]
     229You 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.
     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 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.
     236
     237=== ''Permission denied'' error
     238
     239Typical error message:
     240{{{#!sh
     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 allow the web server (Apache, ...) to post email messages to the local SMTP server.
     248
     249Many users get confused when their manual attempts to contact the SMTP server succeed:
     250{{{#!sh
     251telnet localhost 25
     252}}}
     253This is because a regular user may connect to the SMTP server, but the web server cannot:
     254{{{#!sh
     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 in 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{{{#!sh
     265$ setsebool -P httpd_can_sendmail 1
     266}}}
     267
     268=== ''Suspected spam'' error
     269
     270Some SMTP servers may reject the notification email sent by Trac.
     271
     272The 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.
     273
     274Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
     275
     276----
     277See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]