Changes between Initial Version and Version 1 of TracNotification


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