Changes between Version 1 and Version 2 of TracNotification

Oct 23, 2015, 12:16:58 PM (6 years ago)



  • TracNotification

    v1 v2  
    1 = Email Notification of Ticket Changes =
     1= Email Notification of Ticket Changes
    4 Trac supports basic notification for ticket changes using email.
    6 Email notification is useful to keep users up-to-date on tickets/issues of interest, and also provides a convenient way to post ticket changes to a dedicated mailing list. '''Note:''' As an example, this is how the [ Trac-tickets] mailing list works.
     4Trac supports notification of ticket changes via email.
     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 [ Trac-tickets] mailing list is set up.
    88Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
    10 == Receiving Notification ==
    11 When reporting a new ticket or adding a comment, enter a valid email address in the ''reporter'', ''editor'' or ''cc'' field. Trac will automatically send you an email when changes are made to the ticket.
    13 This is useful to keep up-to-date on an issue or enhancement request that interests you.
    15 == Configuring SMTP Notification ==
    17 === Configuration Options ===
    18 These are the available options for the ''[notification]'' section in trac.ini.
    19  * '''smtp_enabled''': Enable email notification.
    20  * '''smtp_server''': SMTP server used for notification messages.
    21  * '''smtp_user''': (''requires [milestone:0.9 0.9]'') user name for authentication SMTP account.
    22  * '''smtp_password''': (''requires [milestone:0.9 0.9]'') password for authentication SMTP account.
    23  * '''smtp_from''': Email address to use for ''Sender''-headers in notification emails.
    24  * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails.
    25  * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    26  * '''always_notify_reporter''':  Always send notifications to any address in the reporter field.
    27  * '''always_notify_owner''': (''requires [milestone:0.9 0.9]'') Always send notifications to the address in the owner field.
    29 Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    31 === Example Configuration ===
    33 {{{
     10== 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.
     14=== How to use your username to receive notification mails
     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.
     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.
     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`''').
     22=== Ticket attachment notifications
     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:
     27trac.ticket.notification.TicketAttachmentNotifier = disabled
     30== Configuring SMTP Notification
     32'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
     34=== Configuration Options
     36These are the available options for the `[notification]` section in `trac.ini`:
     40=== Example Configuration (SMTP)
    3544smtp_enabled = true
    42 == Sample Email ==
     51=== Example Configuration (`sendmail`)
     55smtp_enabled = true
     56email_sender = SendmailEmailSender
     57sendmail_path = /usr/sbin/sendmail
     58smtp_from =
     59smtp_replyto =
     60smtp_always_cc =,
     63=== Customizing the e-mail subject
     65The e-mail subject can be customized with the `ticket_subject_template` option, which contains a [ Genshi text template] snippet. The default value is:
     67$prefix #$ $summary
     70The following variables are available in the template:
     72 * `env`: The project environment (see [trac:source:/trunk/trac/]).
     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/]). Individual ticket fields can be addressed by appending the field name separated by a dot, eg `$ticket.milestone`.
     77=== Customizing the e-mail content
     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:
     84{% choose %}\
     85{%   when True %}\
     87{%   end %}\
     88{%   otherwise %}\
     89{%     if changes_body %}\
     90${_('Changes (by %(author)s):',}
     93{%     end %}\
     94{%     if changes_descr %}\
     95{%       if not changes_body and not change.comment and %}\
     96${_('Description changed by %(author)s:',}
     97{%       end %}\
     100{%     end %}\
     101{%     if change.comment %}\
     103${changes_body and _('Comment:') or _('Comment (by %(author)s):',}
     106{%     end %}\
     107{%   end %}\
     108{% end %}\
     111${_('Ticket URL: <%(link)s>',}
     112$ <${project.url or abs_href()}>
     116== Sample Email
    44119#42: testing
    53   * component:  changset view => search system
     128  * component:  changeset view => search system
    54129  * priority:  low => highest
    55130  * owner:  jonas => anonymous
    65140My Project <>
     143== Customizing e-mail content for MS Outlook
     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].
     147Replace the following second row in the template:
     152with this (requires Python 2.6 or later):
     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 %}\
     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"
     169#42: testing<br />
     170--------------------------------------------------------------------------<br />
     171<table cellpadding=0>
     178<tr><td>Component:</td><td>report system</td></tr>
     180<tr><td>Resolution:</td><td> </td></tr>
     181<tr><td>Keywords:</td><td> </td></tr>
     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; =&gt;<br />
     190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;,<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;;<br />
     198My Project &lt;;<br />
     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:
     204   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     207However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     209== Using GMail as the SMTP relay host
     211Use the following configuration snippet:
     214smtp_enabled = true
     215use_tls = true
     216mime_encoding = base64
     217smtp_server =
     218smtp_port = 587
     219smtp_user = user
     220smtp_password = password
     223where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [].
     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.
     228== Filtering notifications for one's own changes and comments
     230To delete these notifications in Gmail, use the following filter:
     232from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     235In Thunderbird, there is no such solution if you use IMAP, see
     237You can also add this plugin:
     238, or vote for [trac:#2247] to be fixed.
     240== Troubleshooting
     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.
     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.
     246=== ''Permission denied'' error
     248Typical error message:
     250  ...
     251  File ".../", line 303, in connect
     252    raise socket.error, msg
     253  error: (13, 'Permission denied')
     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.
     258Many users get confused when their manual attempts to contact the SMTP server succeed:
     260telnet localhost 25
     263This is because a regular user may connect to the SMTP server, but the web server cannot:
     265sudo -u www-data telnet localhost 25
     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.
     270Relevant mailing list thread on SELinux:
     272For SELinux in Fedora 10:
     274setsebool -P httpd_can_sendmail 1
     277=== ''Suspected spam'' error
     279Some SMTP servers may reject the notification email sent by Trac.
     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.
     283Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    68 See also: TracTickets, TracIni, TracGuide
     286See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]