Changes between Version 1 and Version 2 of TracNotification


Ignore:
Timestamp:
2023-04-20T18:30:58Z (19 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v1 v2  
    1 = Email Notification of Ticket Changes =
     1= Email Notification of Ticket Changes
    22[[TracGuideToc]]
    33
    4 [[PageOutline]]
    5 
    6 Trac supports notification about ticket changes via email.
    7 
    8 Email 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.
    9 
    10 Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
    11 
    12 == Receiving Notification Mails ==
    13 When reporting a new ticket or adding a comment, enter a valid email address or your 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 
    15 This is useful to keep up-to-date on an issue or enhancement request that interests you.
    16 
    17 === How to use your username to receive notification mails ===
    18 
    19 To receive notification mails, you can either enter a full email address or your username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page.
    20 
    21 Alternatively, 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.
    22 
    23 == Configuring SMTP Notification ==
    24 
    25 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    26 
    27 === Configuration Options ===
    28 These are the available options for the `[notification]` section in trac.ini.
    29 
    30  * '''`smtp_enabled`''': Enable email notification.
    31  * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails.
    32  * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails.
    33  * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
    34  * '''`smtp_default_domain`''': (''since 0.10'') Append the specified domain to addresses that do not contain one. Fully qualified addresses are not modified. The default domain is appended to all username/login for which an email address cannot be found from the user settings.
    35  * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    36  * '''`smtp_always_bcc`''': (''since 0.10'') List of email addresses to always send notifications to, but keeps addresses not visible from other recipients of the notification email
    37  * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
    38  * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false).
    39  * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
    40  * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
    41  * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    42  * '''`use_short_addr`''': (''since 0.10'') Enable delivery of notifications to addresses that do not contain a domain (i.e. do not end with ''@<domain.com>'').This option is useful for intranets, where the SMTP server can handle local addresses and map the username/login to a local mailbox. See also `smtp_default_domain`. Do not use this option with a public SMTP server.
    43  * '''`mime_encoding`''': (''since 0.10'') E-mail notifications are always sent in 7-bit mode. This option allows to select the MIME encoding scheme. Supported values:
    44    * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    45    * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    46    * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
    47  * '''`ticket_subject_template`''': (''since 0.11'') A [http://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet used to get the notification subject.
    48 
    49 Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    50 
    51 The following options are specific to email delivery through SMTP.
    52  * '''`smtp_server`''': SMTP server used for notification messages.
    53  * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
    54  * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
    55  * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
    56  * '''`use_tls`''': (''since 0.10'') Toggle to send notifications via a SMTP server using [http://en.wikipedia.org/wiki/Transport_Layer_Security TLS], such as GMail.
    57 
    58 
    59 === Example Configuration (SMTP) ===
    60 {{{
     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
    6143[notification]
    6244smtp_enabled = true
    … …  
    6749}}}
    6850
    69 
    70 === Customizing the e-mail subject ===
    71 The 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:
    72 {{{
    73 $prefix #$ticket.id: $summary
     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 [https://trac-hacks.org/wiki/OnSiteNotificationsPlugin 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 [https://trac-hacks.org/wiki/TracHtmlNotificationPlugin 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}
    74113}}}
    75114The following variables are available in the template:
    76115
    77  * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     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]).
    78118 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    79119 * `summary`: The ticket summary, with the old value if the summary was edited.
    80  * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, e.g. `$ticket.milestone`.
    81 
    82 === Customizing the e-mail content ===
    83 
    84 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`.  The default looks like this:
    85 
    86 {{{
    87 $ticket_body_hdr
    88 $ticket_props
    89 #choose ticket.new
    90   #when True
    91 $ticket.description
    92   #end
    93   #otherwise
    94     #if changes_body
    95 Changes (by $change.author):
    96 
    97 $changes_body
    98     #end
    99     #if changes_descr
    100       #if not changes_body and not change.comment and change.author
    101 Description changed by $change.author:
    102       #end
    103 $changes_descr
     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}
    104142--
    105     #end
    106     #if change.comment
    107 
    108 Comment${not changes_body and '(by %s)' % change.author or ''}:
    109 
    110 $change.comment
    111     #end
    112   #end
    113 #end
    114 
    115 --
    116 Ticket URL: <$ticket.link>
    117 $project.name <${project.url or abs_href()}>
    118 $project.descr
    119 }}}
    120 == Sample Email ==
     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
    121161{{{
    122162#42: testing
    123163---------------------------+------------------------------------------------
    124        Id:  42             |      Status:  assigned               
     164       Id:  42             |      Status:  assigned
    125165Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
    126  Severity:  major          |   Milestone:  0.9                     
    127  Priority:  lowest         |     Version:  0.6                     
    128     Owner:  anonymous      |    Reporter:  jonas@example.com               
     166 Severity:  major          |   Milestone:  0.9
     167 Priority:  lowest         |     Version:  0.6
     168    Owner:  anonymous      |    Reporter:  jonas@example.com
    129169---------------------------+------------------------------------------------
    130170Changes:
    131   * component:  changset view => search system
     171  * component:  changeset view => search system
    132172  * priority:  low => highest
    133173  * owner:  jonas => anonymous
    … …  
    144184}}}
    145185
    146 == Using GMail as the SMTP relay host ==
    147 
    148 Use the following configuration snippet
    149 {{{
     186== Using GMail as the SMTP relay host
     187
     188Use the following configuration snippet:
     189{{{#!ini
    150190[notification]
    151191smtp_enabled = true
    … …  
    158198}}}
    159199
    160 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     200where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com].
    161201
    162202Alternatively, you can use `smtp_port = 25`.[[br]]
    163 You should not use `smtp_port = 465`. It will not work and your ticket submission may deadlock. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [comment:ticket:7107:2 #7107] for details.
    164  
    165 == Filtering notifications for one's own changes ==
    166 In Gmail, use the filter:
    167 
    168 {{{
    169 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
    170 }}}
    171 
    172 For Trac .10, use the filter:
    173 {{{
    174 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    175 }}}
    176 
    177 to delete these notifications.
    178 
    179 In Thunderbird, there is no such solution if you use IMAP
    180 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
    181 
    182 The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
    183 You will however still get an email if you comment a ticket that you own or have reported.
    184 
    185 You can also add this plugin:
    186 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
    187 
    188 == Troubleshooting ==
    189 
    190 If 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.
    191 
    192 Notification errors are not reported through the web interface, so the user who submit 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.
    193 
    194 === ''Permission denied'' error ===
     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
    195212
    196213Typical error message:
    197 {{{
     214{{{#!sh
    198215  ...
    199216  File ".../smtplib.py", line 303, in connect
    … …  
    202219}}}
    203220
    204 This error usually comes from a security settings on the server: many Linux distributions do not let the web server (Apache, ...) to post email message to the local SMTP server.
     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.
    205222
    206223Many users get confused when their manual attempts to contact the SMTP server succeed:
    207 {{{
     224{{{#!sh
    208225telnet localhost 25
    209226}}}
    210 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    211 {{{
     227This is because a regular user may connect to the SMTP server, but the web server cannot:
     228{{{#!sh
    212229sudo -u www-data telnet localhost 25
    213230}}}
    214231
    215 In 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 browsing the Trac [trac:MailingList MailingList] archive.
     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.
    216233
    217234Relevant ML threads:
    … …  
    219236
    220237For SELinux in Fedora 10:
    221 {{{
     238{{{#!sh
    222239$ setsebool -P httpd_can_sendmail 1
    223240}}}
    224 === ''Suspected spam'' error ===
     241
     242=== Suspected spam error
    225243
    226244Some SMTP servers may reject the notification email sent by Trac.
    227245
    228 The 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, it is recommended to change the default encoding to "quoted-printable" using the `mime_encoding` option.
    229 
    230 Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended to stick with the Base64 encoding.
    231 
    232 === ''501, 5.5.4 Invalid Address'' error ===
    233 
    234 On IIS 6.0 you could get a
    235 {{{
    236 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
    237 }}}
    238 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
    239 
     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=== Emails not sent
     251
     252If you are switching back to using Trac to send emails from, say, the [https://trac-hacks.org/wiki/AnnouncerPlugin AnnouncerPlugin], be sure to enable `EmailDistributor` in your Trac configuration. It may have been disabled when using an email plugin. There may be no message in the Trac log when all is good to go, but the actual sending is disabled.
    240253
    241254----
    242 See also: TracTickets, TracIni, TracGuide
     255See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]