Edgewall Software

Changes between Initial Version and Version 1 of 1.2/TracNotification


Ignore:
Timestamp:
Oct 15, 2019, 6:32:48 AM (3 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • 1.2/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 of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list.
     8
     9Disabled by default, notification can be activated and configured in [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 your [/prefs preferences].
     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:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated.
     33
     34=== Configuration Options
     35These are the available options for the `[notification]` section in trac.ini:
     36
     37[[TracIni(section=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 [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
     62
     63[[TracIni(section=notification-subscriber)]]
     64
     65Each user can override these defaults in their ''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
     69The subscription rule name on the left side of the `=` can be anything, it has no meaning outside this configuration file. The subscriber name on the right side of the `=` must be one of the subscribers listed in the above table.
     70
     71The following attributes of default subscriptions can be configured:
     72* `.distributor` (Default: `email`)
     73  * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.
     74* `.priority` (Default: `100`)
     75  * Smaller values override larger values.
     76  * If you use `0`, then users will not be able to override this rule.
     77* `.adverb` (Default: `always`)
     78  * `never` can be used to silence other subscription rules with higher values.
     79* `.format` (Default: `text/plain`)
     80  * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.
     81
     82=== Example Configuration (default subscriptions)
     83{{{#!ini
     84[notification-subscriber]
     85always_notify_owner = TicketOwnerSubscriber
     86always_notify_owner.distributor = email
     87always_notify_owner.priority = 100
     88always_notify_owner.adverb = always
     89always_notify_owner.format = text/plain
     90
     91always_notify_previous_updater = TicketPreviousUpdatersSubscriber
     92
     93never_notify_updater = TicketUpdaterSubscriber
     94never_notify_updater.adverb = never
     95never_notify_updater.priority = 0
     96
     97notify_cc_html = CarbonCopySubscriber
     98notify_cc_html.format = text/html
     99}}}
     100
     101=== Customizing the email subject
     102The email subject can be customized with the `ticket_subject_template` option, which contains a [https://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet. The default value is:
     103{{{#!genshi
     104${prefix} #${ticket.id}: ${summary}
     105}}}
     106The following variables are available in the template:
     107
     108 * `env`: The project environment object (see [trac:source:branches/1.2-stable/trac/env.py env.py]).
     109 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     110 * `summary`: The ticket summary, with the old value if the summary was edited.
     111 * `ticket`: The ticket model object (see [trac:source:branches/1.2-stable/trac/ticket/model.py model.py]). Individual ticket fields can be accessed by appending the field name separated by a dot, eg `${ticket.milestone}`.
     112
     113=== Customizing the email content
     114
     115The notification email 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 is:
     116
     117{{{#!genshi
     118$ticket_body_hdr
     119$ticket_props
     120{% choose ticket.new %}\
     121{%   when True %}\
     122$ticket.description
     123{%   end %}\
     124{%   otherwise %}\
     125{%     if changes_body %}\
     126${_('Changes (by %(author)s):', author=change.author)}
     127
     128$changes_body
     129{%     end %}\
     130{%     if changes_descr %}\
     131{%       if not changes_body and not change.comment and change.author %}\
     132${_('Description changed by %(author)s:', author=change.author)}
     133{%       end %}\
     134$changes_descr
     135--
     136{%     end %}\
     137{%     if change.comment %}\
     138
     139${_('Comment:') if changes_body else _('Comment (by %(author)s):', author=change.author)}
     140
     141$change.comment
     142{%     end %}\
     143{%   end %}\
     144{% end %}\
     145
     146${'-- '}
     147${_('Ticket URL: <%(link)s>', link=ticket.link)}
     148$project.name <${project.url or abs_href()}>
     149$project.descr
     150}}}
     151
     152See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
     153
     154== Sample Email
     155{{{
     156#42: testing
     157---------------------------+------------------------------------------------
     158       Id:  42             |      Status:  assigned               
     159Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
     160 Severity:  major          |   Milestone:  0.9                     
     161 Priority:  lowest         |     Version:  0.6                     
     162    Owner:  anonymous      |    Reporter:  jonas@example.com               
     163---------------------------+------------------------------------------------
     164Changes:
     165  * component:  changeset view => search system
     166  * priority:  low => highest
     167  * owner:  jonas => anonymous
     168  * cc:  daniel@example.com =>
     169         daniel@example.com, jonas@example.com
     170  * status:  new => assigned
     171
     172Comment:
     173I'm interested too!
     174
     175--
     176Ticket URL: <http://example.com/trac/ticket/42>
     177My Project <http://myproj.example.com/>
     178}}}
     179
     180== Using GMail as the SMTP relay host
     181
     182Use the following configuration snippet:
     183{{{#!ini
     184[notification]
     185smtp_enabled = true
     186use_tls = true
     187mime_encoding = base64
     188smtp_server = smtp.gmail.com
     189smtp_port = 587
     190smtp_user = user
     191smtp_password = password
     192}}}
     193
     194where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com].
     195
     196Alternatively, you can use `smtp_port = 25`.[[br]]
     197You 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.
     198
     199== Troubleshooting
     200
     201If notifications are not working, inspect the [TracLogging log] for error messages.
     202
     203Notification errors are not always reported through the web interface, so the user who submits a change or creates a ticket may not get notified about a notification failure. The Trac administrator needs to look at the log to find the error message and traceback.
     204
     205=== ''Permission denied'' error
     206
     207Typical error message:
     208{{{#!sh
     209  ...
     210  File ".../smtplib.py", line 303, in connect
     211    raise socket.error, msg
     212  error: (13, 'Permission denied')
     213}}}
     214
     215This 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.
     216
     217Many users get confused when their manual attempts to contact the SMTP server succeed:
     218{{{#!sh
     219telnet localhost 25
     220}}}
     221This is because a regular user may connect to the SMTP server, but the web server cannot:
     222{{{#!sh
     223sudo -u www-data telnet localhost 25
     224}}}
     225
     226In 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.
     227
     228Relevant ML threads:
     229 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     230
     231For SELinux in Fedora 10:
     232{{{#!sh
     233$ setsebool -P httpd_can_sendmail 1
     234}}}
     235
     236=== ''Suspected spam'' error
     237
     238Some SMTP servers may reject the notification email sent by Trac.
     239
     240The 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.
     241
     242Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
     243
     244----
     245See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]