Changes between Initial Version and Version 1 of TracNotification


Ignore:
Timestamp:
Apr 21, 2020, 11:11:05 PM (21 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 Trac username in the ''reporter'', ''assigned to/owner'' or ''cc'' field. Trac may send you an email when changes are made to the ticket, depending on how your notification preferences are configured.
     12
     13Permission groups can also be entered in the CC field,
     14to notify all members of the group.
     15
     16=== How to use your username to receive notification mails
     17
     18To 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.
     19
     20Alternatively, 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.
     21
     22When 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`''').
     23
     24=== Ticket attachment notifications
     25
     26Since 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:
     27{{{#!ini
     28[components]
     29trac.ticket.notification.TicketAttachmentNotifier = disabled
     30}}}
     31
     32== Configuring SMTP Notification
     33
     34'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
     35
     36=== Configuration Options
     37These are the available options for the `[notification]` section in trac.ini:
     38
     39[[TracIni(section=notification)]]
     40
     41=== Example Configuration (SMTP)
     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{{{#!ini
     53[notification]
     54smtp_enabled = true
     55email_sender = SendmailEmailSender
     56sendmail_path = /usr/sbin/sendmail
     57smtp_from = notifier@example.com
     58smtp_replyto = myproj@projects.example.com
     59smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     60}}}
     61
     62=== Subscriber Configuration
     63The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
     64
     65[[TracIni(section=notification-subscriber)]]
     66
     67Each user can override these defaults in his ''Notifications'' preferences.
     68
     69For 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.
     70
     71=== Customizing the e-mail subject
     72The e-mail subject can be customized with the `ticket_subject_template` option, which contains a [http://genshi.edgewall.org/wiki/Documentation/text-templates.html text template] snippet. The default value is:
     73{{{#!genshi
     74${prefix} #${ticket.id}: ${summary}
     75}}}
     76The following variables are available in the template:
     77
     78 * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]).
     79 * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]).
     80 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     81 * `summary`: The ticket summary, with the old value if the summary was edited.
     82 * `ticket`: The ticket model object (see [trac:source:/branches/1.4-stable/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, eg `$ticket.milestone`.
     83
     84=== Customizing the e-mail content
     85
     86The 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:
     87
     88{{{#!genshi
     89$ticket_body_hdr
     90$ticket_props
     91{% choose ticket.new %}\
     92{%   when True %}\
     93$ticket.description
     94{%   end %}\
     95{%   otherwise %}\
     96{%     if changes_body %}\
     97${_('Changes (by %(author)s):', author=change.author)}
     98
     99$changes_body
     100{%     end %}\
     101{%     if changes_descr %}\
     102{%       if not changes_body and not change.comment and change.author %}\
     103${_('Description changed by %(author)s:', author=change.author)}
     104{%       end %}\
     105$changes_descr
     106--
     107{%     end %}\
     108{%     if change.comment %}\
     109
     110${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     111
     112$change.comment
     113{%     end %}\
     114{%   end %}\
     115{% end %}\
     116
     117--
     118${_('Ticket URL: <%(link)s>', link=ticket.link)}
     119$project.name <${project.url or abs_href()}>
     120$project.descr
     121}}}
     122
     123== Sample Email
     124{{{
     125#42: testing
     126---------------------------+------------------------------------------------
     127       Id:  42             |      Status:  assigned               
     128Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
     129 Severity:  major          |   Milestone:  0.9                     
     130 Priority:  lowest         |     Version:  0.6                     
     131    Owner:  anonymous      |    Reporter:  jonas@example.com               
     132---------------------------+------------------------------------------------
     133Changes:
     134  * component:  changeset view => search system
     135  * priority:  low => highest
     136  * owner:  jonas => anonymous
     137  * cc:  daniel@example.com =>
     138         daniel@example.com, jonas@example.com
     139  * status:  new => assigned
     140
     141Comment:
     142I'm interested too!
     143
     144--
     145Ticket URL: <http://example.com/trac/ticket/42>
     146My Project <http://myproj.example.com/>
     147}}}
     148
     149== Customizing e-mail content for MS Outlook
     150
     151MS 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].
     152
     153Replace the following second row in the template:
     154{{{
     155$ticket_props
     156}}}
     157
     158with this (requires Python 2.6 or later):
     159{{{
     160--------------------------------------------------------------------------
     161{% with
     162   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     163         [c.strip() for c in
     164          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     165   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     166          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     167${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     168{% end %}\
     169--------------------------------------------------------------------------
     170}}}
     171
     172The 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.
     173{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     174{{{#!html
     175#42: testing<br />
     176--------------------------------------------------------------------------<br />
     177<table cellpadding=0>
     178<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     179<tr><td>Owner:</td><td>anonymous</td></tr>
     180<tr><td>Type:</td><td>defect</td></tr>
     181<tr><td>Status:</td><td>assigned</td></tr>
     182<tr><td>Priority:</td><td>lowest</td></tr>
     183<tr><td>Milestone:</td><td>0.9</td></tr>
     184<tr><td>Component:</td><td>report system</td></tr>
     185<tr><td>Severity:</td><td>major</td></tr>
     186<tr><td>Resolution:</td><td> </td></tr>
     187<tr><td>Keywords:</td><td> </td></tr>
     188</table>
     189--------------------------------------------------------------------------<br />
     190Changes:<br />
     191<br />
     192&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     193&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     194&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     195&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     197&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     198<br />
     199Comment:<br />
     200I'm interested too!<br />
     201<br />
     202--<br />
     203Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     204My Project &lt;http://myproj.example.com/&gt;<br />
     205}}}
     206}}}
     207
     208**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:
     209{{{
     210   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     211}}}
     212
     213However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     214
     215== Using GMail as the SMTP relay host
     216
     217Use the following configuration snippet:
     218{{{#!ini
     219[notification]
     220smtp_enabled = true
     221use_tls = true
     222mime_encoding = base64
     223smtp_server = smtp.gmail.com
     224smtp_port = 587
     225smtp_user = user
     226smtp_password = password
     227}}}
     228
     229where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     230
     231Alternatively, you can use `smtp_port = 25`.[[br]]
     232You 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.
     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{{{#!sh
     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{{{#!sh
     254telnet localhost 25
     255}}}
     256This is because a regular user may connect to the SMTP server, but the web server cannot:
     257{{{#!sh
     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{{{#!sh
     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]