Changes between Version 3 and Version 4 of TracNotification


Ignore:
Timestamp:
01/09/21 11:52:22 (12 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v3 v4  
    1 = Email Notification of Ticket Changes =
     1= Email Notification of Ticket Changes
    22[[TracGuideToc]]
    33
    4 Trac supports notification of ticket changes via email.
    5 
    6 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.
    7 
    8 Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
    9 
    10 == Receiving Notification Mails ==
    11 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).
    12 
    13 This is useful to keep up-to-date on an issue or enhancement request that interests you.
    14 
    15 === How to use your username to receive notification mails ===
    16 
    17 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.
    18 
    19 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.
    20 
    21 == Configuring SMTP Notification ==
    22 
    23 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    24 
    25 === Configuration Options ===
    26 These are the available options for the `[notification]` section in trac.ini.
    27 
    28  * '''`smtp_enabled`''': Enable email notification.
    29  * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails.
    30  * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails.
    31  * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
    32  * '''`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.
    33  * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    34  * '''`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
    35  * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
    36  * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false).
    37  * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
    38  * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
    39  * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    40  * '''`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.
    41  * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values:
    42    * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.
    43    * `base64`: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    44    * `qp` or `quoted-printable`: best for european languages (more compact than base64) if 8bit encoding cannot be used.
    45  * '''`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.
    46  * '''`email_sender`''': (''since 0.12'') Name of the component implementing `IEmailSender`. This component is used by the notification system to send emails. Trac currently provides the following components:
    47    * `SmtpEmailSender`: connects to an SMTP server (default).
    48    * `SendmailEmailSender`: runs a `sendmail`-compatible executable.
    49 
    50 Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    51 
    52 The following options are specific to email delivery through SMTP.
    53  * '''`smtp_server`''': SMTP server used for notification messages.
    54  * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
    55  * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
    56  * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
    57  * '''`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.
    58 
    59 The following option is specific to email delivery through a `sendmail`-compatible executable.
    60  * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options.
    61 
    62 === Example Configuration (SMTP) ===
    63 {{{
     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
    6443[notification]
    6544smtp_enabled = true
     
    7049}}}
    7150
    72 === Example Configuration (`sendmail`) ===
    73 {{{
     51=== Example Configuration (`sendmail`)
     52{{{#!ini
    7453[notification]
    7554smtp_enabled = true
     
    8160}}}
    8261
    83 === Customizing the e-mail subject ===
    84 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:
    85 {{{
    86 $prefix #$ticket.id: $summary
     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{{{#!ini
     86[notification-subscriber]
     87always_notify_owner = TicketOwnerSubscriber
     88always_notify_owner.distributor = email
     89always_notify_owner.priority = 100
     90always_notify_owner.adverb = always
     91always_notify_owner.format = text/plain
     92
     93always_notify_previous_updater = TicketPreviousUpdatersSubscriber
     94
     95never_notify_updater = TicketUpdaterSubscriber
     96never_notify_updater.adverb = never
     97never_notify_updater.priority = 0
     98
     99notify_cc_html = CarbonCopySubscriber
     100notify_cc_html.format = text/html
     101}}}
     102
     103=== Customizing the email subject
     104The 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:
     105{{{#!genshi
     106${prefix} #${ticket.id}: ${summary}
    87107}}}
    88108The following variables are available in the template:
    89109
    90  * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     110 * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]).
     111 * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]).
    91112 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    92113 * `summary`: The ticket summary, with the old value if the summary was edited.
    93  * `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`.
    94 
    95 === Customizing the e-mail content ===
    96 
    97 The 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:
    98 
    99 {{{
    100 $ticket_body_hdr
    101 $ticket_props
    102 #choose ticket.new
    103   #when True
    104 $ticket.description
    105   #end
    106   #otherwise
    107     #if changes_body
    108 Changes (by $change.author):
    109 
    110 $changes_body
    111     #end
    112     #if changes_descr
    113       #if not changes_body and not change.comment and change.author
    114 Description changed by $change.author:
    115       #end
    116 $changes_descr
     114 * `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}`.
     115
     116=== Customizing the email content #CustomizingContent
     117
     118The 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:
     119
     120{{{#!jinja
     121${ticket_body_hdr}
     122${ticket_props}
     123# if ticket.new:
     124${ticket.description}
     125# else:
     126#   if changes_body:
     127${_('Changes (by %(author)s):', author=change.author)}
     128
     129${changes_body}
     130#   endif
     131#   if changes_descr:
     132#     if not changes_body and not change.comment and change.author:
     133${_('Description changed by %(author)s:', author=change.author)}
     134#     endif
     135${changes_descr}
    117136--
    118     #end
    119     #if change.comment
    120 
    121 Comment${not changes_body and '(by %s)' % change.author or ''}:
    122 
    123 $change.comment
    124     #end
    125   #end
    126 #end
    127 
    128 --
    129 Ticket URL: <$ticket.link>
    130 $project.name <${project.url or abs_href()}>
    131 $project.descr
    132 }}}
    133 == Sample Email ==
     137#   endif
     138#   if change.comment:
     139
     140${_('Comment:') if changes_body else
     141  _('Comment (by %(author)s):', author=change.author)}
     142
     143${change.comment}
     144#   endif
     145# endif
     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
    134155{{{
    135156#42: testing
    136157---------------------------+------------------------------------------------
    137        Id:  42             |      Status:  assigned               
     158       Id:  42             |      Status:  assigned
    138159Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
    139  Severity:  major          |   Milestone:  0.9                     
    140  Priority:  lowest         |     Version:  0.6                     
    141     Owner:  anonymous      |    Reporter:  jonas@example.com               
     160 Severity:  major          |   Milestone:  0.9
     161 Priority:  lowest         |     Version:  0.6
     162    Owner:  anonymous      |    Reporter:  jonas@example.com
    142163---------------------------+------------------------------------------------
    143164Changes:
    144   * component:  changset view => search system
     165  * component:  changeset view => search system
    145166  * priority:  low => highest
    146167  * owner:  jonas => anonymous
     
    157178}}}
    158179
    159 == Using GMail as the SMTP relay host ==
    160 
    161 Use the following configuration snippet
    162 {{{
     180== Using GMail as the SMTP relay host
     181
     182Use the following configuration snippet:
     183{{{#!ini
    163184[notification]
    164185smtp_enabled = true
     
    171192}}}
    172193
    173 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     194where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com].
    174195
    175196Alternatively, you can use `smtp_port = 25`.[[br]]
    176 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.
    177  
    178 == Filtering notifications for one's own changes ==
    179 In Gmail, use the filter:
    180 
    181 {{{
    182 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
    183 }}}
    184 
    185 For Trac .10, use the filter:
    186 {{{
    187 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    188 }}}
    189 
    190 to delete these notifications.
    191 
    192 In Thunderbird, there is no such solution if you use IMAP
    193 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
    194 
    195 The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
    196 You will however still get an email if you comment a ticket that you own or have reported.
    197 
    198 You can also add this plugin:
    199 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
    200 
    201 == Troubleshooting ==
    202 
    203 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.
    204 
    205 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.
    206 
    207 === ''Permission denied'' error ===
     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
    208206
    209207Typical error message:
    210 {{{
     208{{{#!sh
    211209  ...
    212210  File ".../smtplib.py", line 303, in connect
     
    215213}}}
    216214
    217 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.
     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.
    218216
    219217Many users get confused when their manual attempts to contact the SMTP server succeed:
    220 {{{
     218{{{#!sh
    221219telnet localhost 25
    222220}}}
    223 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    224 {{{
     221This is because a regular user may connect to the SMTP server, but the web server cannot:
     222{{{#!sh
    225223sudo -u www-data telnet localhost 25
    226224}}}
    227225
    228 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.
     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.
    229227
    230228Relevant ML threads:
     
    232230
    233231For SELinux in Fedora 10:
    234 {{{
     232{{{#!sh
    235233$ setsebool -P httpd_can_sendmail 1
    236234}}}
    237 === ''Suspected spam'' error ===
     235
     236=== ''Suspected spam'' error
    238237
    239238Some SMTP servers may reject the notification email sent by Trac.
    240239
    241 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.
    242 
    243 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.
    244 
    245 === ''501, 5.5.4 Invalid Address'' error ===
    246 
    247 On IIS 6.0 you could get a
    248 {{{
    249 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
    250 }}}
    251 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
    252 
     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.
    253243
    254244----
    255 See also: TracTickets, TracIni, TracGuide
     245See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]