Changes between Version 4 and Version 5 of TracNotification


Ignore:
Timestamp:
04/07/2021 11:15:20 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v4 v5  
    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.
     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.
    2021
    2122When 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`''').
    2223
    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_from_author`''': (''since 1.0'') Use the author of a change (the reporter of a new ticket, or the author of a comment) as the `From:` header value in notification e-mails (default: false). If the author hasn't set an e-mail address, `smtp_from` and `smtp_from_name` are used instead.
    34  * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
    35  * '''`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.
    36  * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    37  * '''`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
    38  * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
    39  * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false).
    40  * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
    41  * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
    42  * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    43  * '''`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.
    44  * '''`ignore_domains`''': Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).
    45  * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values:
    46    * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.
    47    * `base64`: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    48    * `qp` or `quoted-printable`: best for european languages (more compact than base64) if 8bit encoding cannot be used.
    49  * '''`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.
    50  * '''`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:
    51    * `SmtpEmailSender`: connects to an SMTP server (default).
    52    * `SendmailEmailSender`: runs a `sendmail`-compatible executable.
    53 
    54 Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    55 
    56 The following options are specific to email delivery through SMTP.
    57  * '''`smtp_server`''': SMTP server used for notification messages.
    58  * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
    59  * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
    60  * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
    61  * '''`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.
    62 
    63 The following option is specific to email delivery through a `sendmail`-compatible executable.
    64  * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options.
    65 
    66 === Example Configuration (SMTP) ===
    67 {{{
     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
    6843[notification]
    6944smtp_enabled = true
    … …  
    7449}}}
    7550
    76 === Example Configuration (`sendmail`) ===
    77 {{{
     51=== Example Configuration (`sendmail`)
     52{{{#!ini
    7853[notification]
    7954smtp_enabled = true
    … …  
    8560}}}
    8661
    87 === Customizing the e-mail subject ===
    88 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:
    89 {{{
    90 $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}
    91107}}}
    92108The following variables are available in the template:
    93109
    94  * `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]).
    95112 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    96113 * `summary`: The ticket summary, with the old value if the summary was edited.
    97  * `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`.
    98 
    99 === Customizing the e-mail content ===
    100 
    101 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/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:
    102 
    103 {{{
    104 $ticket_body_hdr
    105 $ticket_props
    106 {% choose ticket.new %}\
    107 {%   when True %}\
    108 $ticket.description
    109 {%   end %}\
    110 {%   otherwise %}\
    111 {%     if changes_body %}\
     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:
    112127${_('Changes (by %(author)s):', author=change.author)}
    113128
    114 $changes_body
    115 {%     end %}\
    116 {%     if changes_descr %}\
    117 {%       if not changes_body and not change.comment and change.author %}\
     129${changes_body}
     130#   endif
     131#   if changes_descr:
     132#     if not changes_body and not change.comment and change.author:
    118133${_('Description changed by %(author)s:', author=change.author)}
    119 {%       end %}\
    120 $changes_descr
     134#     endif
     135${changes_descr}
    121136--
    122 {%     end %}\
    123 {%     if change.comment %}\
    124 
    125 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
    126 
    127 $change.comment
    128 {%     end %}\
    129 {%   end %}\
    130 {% end %}\
    131 
    132 --
     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${'-- '}
    133147${_('Ticket URL: <%(link)s>', link=ticket.link)}
    134 $project.name <${project.url or abs_href()}>
    135 $project.descr
    136 }}}
    137 == Sample Email ==
     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
    138155{{{
    139156#42: testing
    140157---------------------------+------------------------------------------------
    141        Id:  42             |      Status:  assigned               
     158       Id:  42             |      Status:  assigned
    142159Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
    143  Severity:  major          |   Milestone:  0.9                     
    144  Priority:  lowest         |     Version:  0.6                     
    145     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
    146163---------------------------+------------------------------------------------
    147164Changes:
    148   * component:  changset view => search system
     165  * component:  changeset view => search system
    149166  * priority:  low => highest
    150167  * owner:  jonas => anonymous
    … …  
    161178}}}
    162179
    163 
    164 == Customizing e-mail content for MS Outlook ==
    165 
    166 Out-of-the-box, MS Outlook normally presents plain text e-mails with a variable-width font; the ticket properties table will most certainly look like a mess in MS Outlook. This can be fixed with some customization of the [#Customizingthee-mailcontent e-mail template].
    167 
    168 Replace the following second row in the template:
    169 {{{
    170 $ticket_props
    171 }}}
    172 
    173 with this instead (''requires Python 2.6 or later''):
    174 {{{
    175 --------------------------------------------------------------------------
    176 {% with
    177    pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
    178          [c.strip() for c in
    179           ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
    180    sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
    181           'Component', 'Severity', 'Resolution', 'Keywords'] %}\
    182 ${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
    183 {% end %}\
    184 --------------------------------------------------------------------------
    185 }}}
    186 
    187 The table of ticket properties is replaced with a list of a selection of the properties. A tab character separates the name and value in such a way that most people should find this more pleasing than the default table, when using MS Outlook.
    188 {{{#!div style="margin: 1em 1.75em; border:1px dotted"
    189 {{{#!html
    190 #42: testing<br />
    191 --------------------------------------------------------------------------<br />
    192 <table cellpadding=0>
    193 <tr><td>Reporter:</td><td>jonas@example.com</td></tr>
    194 <tr><td>Owner:</td><td>anonymous</td></tr>
    195 <tr><td>Type:</td><td>defect</td></tr>
    196 <tr><td>Status:</td><td>assigned</td></tr>
    197 <tr><td>Priority:</td><td>lowest</td></tr>
    198 <tr><td>Milestone:</td><td>0.9</td></tr>
    199 <tr><td>Component:</td><td>report system</td></tr>
    200 <tr><td>Severity:</td><td>major</td></tr>
    201 <tr><td>Resolution:</td><td> </td></tr>
    202 <tr><td>Keywords:</td><td> </td></tr>
    203 </table>
    204 --------------------------------------------------------------------------<br />
    205 Changes:<br />
    206 <br />
    207 &nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
    208 &nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    209 &nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
    210 &nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
    211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
    212 &nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
    213 <br />
    214 Comment:<br />
    215 I'm interested too!<br />
    216 <br />
    217 --<br />
    218 Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
    219 My Project &lt;http://myproj.example.com/&gt;<br />
    220 }}}
    221 }}}
    222 
    223 **Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which shall be part of the mail they have to be added to `sel`, example:
    224 {{{
    225    sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    226 }}}
    227 
    228 However, it's not as perfect as an automatically HTML-formatted e-mail would be, but presented ticket properties are at least readable by default in MS Outlook...
    229 
    230 
    231 == Using GMail as the SMTP relay host ==
    232 
    233 Use the following configuration snippet
    234 {{{
     180== Using GMail as the SMTP relay host
     181
     182Use the following configuration snippet:
     183{{{#!ini
    235184[notification]
    236185smtp_enabled = true
    … …  
    243192}}}
    244193
    245 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].
    246195
    247196Alternatively, you can use `smtp_port = 25`.[[br]]
    248 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.
    249  
    250 == Filtering notifications for one's own changes ==
    251 In Gmail, use the filter:
    252 
    253 {{{
    254 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
    255 }}}
    256 
    257 For Trac .10, use the filter:
    258 {{{
    259 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    260 }}}
    261 
    262 to delete these notifications.
    263 
    264 In Thunderbird, there is no such solution if you use IMAP
    265 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
    266 
    267 The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
    268 You will however still get an email if you comment a ticket that you own or have reported.
    269 
    270 You can also add this plugin:
    271 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
    272 
    273 == Troubleshooting ==
    274 
    275 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.
    276 
    277 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.
    278 
    279 === ''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
    280206
    281207Typical error message:
    282 {{{
     208{{{#!sh
    283209  ...
    284210  File ".../smtplib.py", line 303, in connect
    … …  
    287213}}}
    288214
    289 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.
    290216
    291217Many users get confused when their manual attempts to contact the SMTP server succeed:
    292 {{{
     218{{{#!sh
    293219telnet localhost 25
    294220}}}
    295 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    296 {{{
     221This is because a regular user may connect to the SMTP server, but the web server cannot:
     222{{{#!sh
    297223sudo -u www-data telnet localhost 25
    298224}}}
    299225
    300 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.
    301227
    302228Relevant ML threads:
    … …  
    304230
    305231For SELinux in Fedora 10:
    306 {{{
     232{{{#!sh
    307233$ setsebool -P httpd_can_sendmail 1
    308234}}}
    309 === ''Suspected spam'' error ===
     235
     236=== ''Suspected spam'' error
    310237
    311238Some SMTP servers may reject the notification email sent by Trac.
    312239
    313 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.
    314 
    315 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.
    316 
    317 === ''501, 5.5.4 Invalid Address'' error ===
    318 
    319 On IIS 6.0 you could get a
    320 {{{
    321 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
    322 }}}
    323 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
    324 
     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.
    325243
    326244----
    327 See also: TracTickets, TracIni, TracGuide
     245See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]