Changes between Initial Version and Version 1 of TracNotification


Ignore:
Timestamp:
Oct 17, 2017, 5:50:45 PM (3 years 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 will automatically send you an email when changes are made to the ticket, depending on how notification is configured.
     12
     13=== How to use your username to receive notification mails
     14
     15To 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].
     16
     17Alternatively, 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.
     18
     19When 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`''').
     20
     21=== Ticket attachment notifications
     22
     23Since 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:
     24{{{#!ini
     25[components]
     26trac.ticket.notification.TicketAttachmentNotifier = disabled
     27}}}
     28
     29== Configuring SMTP Notification
     30
     31'''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated.
     32
     33=== Configuration Options
     34These are the available options for the `[notification]` section in trac.ini:
     35
     36[[TracIni(section=notification)]]
     37
     38=== Example Configuration (SMTP)
     39{{{#!ini
     40[notification]
     41smtp_enabled = true
     42smtp_server = mail.example.com
     43smtp_from = notifier@example.com
     44smtp_replyto = myproj@projects.example.com
     45smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     46}}}
     47
     48=== Example Configuration (`sendmail`)
     49{{{#!ini
     50[notification]
     51smtp_enabled = true
     52email_sender = SendmailEmailSender
     53sendmail_path = /usr/sbin/sendmail
     54smtp_from = notifier@example.com
     55smtp_replyto = myproj@projects.example.com
     56smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     57}}}
     58
     59=== Subscriber Configuration
     60The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
     61
     62[[TracIni(section=notification-subscriber)]]
     63
     64Each user can override these defaults in their ''Notifications'' preferences.
     65
     66For 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.
     67
     68The 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.
     69
     70The following attributes of default subscriptions can be configured:
     71* `.distributor` (Default: `email`)
     72  * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.
     73* `.priority` (Default: `100`)
     74  * Smaller values override larger values.
     75  * If you use `0`, then users will not be able to override this rule.
     76* `.adverb` (Default: `always`)
     77  * `never` can be used to silence other subscription rules with higher values.
     78* `.format` (Default: `text/plain`)
     79  * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.
     80
     81=== Example Configuration (default subscriptions)
     82{{{#!ini
     83[notification-subscriber]
     84always_notify_owner = TicketOwnerSubscriber
     85always_notify_owner.distributor = email
     86always_notify_owner.priority = 100
     87always_notify_owner.adverb = always
     88always_notify_owner.format = text/plain
     89
     90always_notify_previous_updater = TicketPreviousUpdatersSubscriber
     91
     92never_notify_updater = TicketUpdaterSubscriber
     93never_notify_updater.adverb = never
     94never_notify_updater.priority = 0
     95
     96notify_cc_html = CarbonCopySubscriber
     97notify_cc_html.format = text/html
     98}}}
     99
     100=== Customizing the e-mail subject
     101The 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:
     102{{{#!genshi
     103${prefix} #${ticket.id}: ${summary}
     104}}}
     105The following variables are available in the template:
     106
     107 * `env`: The project environment object (see [trac:source:/trunk/trac/env.py env.py]).
     108 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     109 * `summary`: The ticket summary, with the old value if the summary was edited.
     110 * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/model.py model.py]). Individual ticket fields can be accessed by appending the field name separated by a dot, eg `${ticket.milestone}`.
     111
     112=== Customizing the e-mail content
     113
     114The 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 is:
     115
     116{{{#!genshi
     117${ticket_body_hdr}
     118${ticket_props}
     119# if ticket.new:
     120${ticket.description}
     121# else:
     122#   if changes_body:
     123${_('Changes (by %(author)s):', author=change.author)}
     124
     125${changes_body}
     126#   endif
     127#   if changes_descr:
     128#     if not changes_body and not change.comment and change.author:
     129${_('Description changed by %(author)s:', author=change.author)}
     130#     endif
     131${changes_descr}
     132--
     133#   endif
     134#   if change.comment:
     135
     136${_('Comment:') if changes_body else
     137  _('Comment (by %(author)s):', author=change.author)}
     138
     139${change.comment}
     140#   endif
     141# endif
     142--
     143${_('Ticket URL: <%(link)s>', link=ticket.link)}
     144${project.name} <${project.url or abs_href()}>
     145${project.descr}
     146}}}
     147
     148See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
     149
     150== Sample Email
     151{{{
     152#42: testing
     153---------------------------+------------------------------------------------
     154       Id:  42             |      Status:  assigned               
     155Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
     156 Severity:  major          |   Milestone:  0.9                     
     157 Priority:  lowest         |     Version:  0.6                     
     158    Owner:  anonymous      |    Reporter:  jonas@example.com               
     159---------------------------+------------------------------------------------
     160Changes:
     161  * component:  changeset view => search system
     162  * priority:  low => highest
     163  * owner:  jonas => anonymous
     164  * cc:  daniel@example.com =>
     165         daniel@example.com, jonas@example.com
     166  * status:  new => assigned
     167
     168Comment:
     169I'm interested too!
     170
     171--
     172Ticket URL: <http://example.com/trac/ticket/42>
     173My Project <http://myproj.example.com/>
     174}}}
     175
     176== Using GMail as the SMTP relay host
     177
     178Use the following configuration snippet:
     179{{{#!ini
     180[notification]
     181smtp_enabled = true
     182use_tls = true
     183mime_encoding = base64
     184smtp_server = smtp.gmail.com
     185smtp_port = 587
     186smtp_user = user
     187smtp_password = password
     188}}}
     189
     190where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     191
     192Alternatively, you can use `smtp_port = 25`.[[br]]
     193You 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.
     194
     195== Troubleshooting
     196
     197If notifications are not working, inspect the [TracLogging log] for error messages.
     198
     199Notification 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.
     200
     201=== ''Permission denied'' error
     202
     203Typical error message:
     204{{{#!sh
     205  ...
     206  File ".../smtplib.py", line 303, in connect
     207    raise socket.error, msg
     208  error: (13, 'Permission denied')
     209}}}
     210
     211This 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.
     212
     213Many users get confused when their manual attempts to contact the SMTP server succeed:
     214{{{#!sh
     215telnet localhost 25
     216}}}
     217This is because a regular user may connect to the SMTP server, but the web server cannot:
     218{{{#!sh
     219sudo -u www-data telnet localhost 25
     220}}}
     221
     222In 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.
     223
     224Relevant ML threads:
     225 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     226
     227For SELinux in Fedora 10:
     228{{{#!sh
     229$ setsebool -P httpd_can_sendmail 1
     230}}}
     231
     232=== ''Suspected spam'' error
     233
     234Some SMTP servers may reject the notification email sent by Trac.
     235
     236The 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.
     237
     238Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
     239
     240----
     241See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]