Changes between Version 2 and Version 3 of TracNotification


Ignore:
Timestamp:
07/02/18 16:35:04 (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v2 v3  
    1 = Email Notification of Ticket Changes =
     1= Email Notification of Ticket Changes
    22[[TracGuideToc]]
    33
    … …  
    88Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
    99
    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.
     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 the ''Preferences'' page.
     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.
    2018
    2119When 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`''').
    2220
    23 == Configuring SMTP Notification ==
     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
    2430
    2531'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    2632
    27 === Configuration Options ===
    28 These are the available options for the `[notification]` section in trac.ini.
    29 
    30 [[TracIni(notification)]]
    31 
    32 === Example Configuration (SMTP) ===
    33 {{{
     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
    3440[notification]
    3541smtp_enabled = true
    … …  
    4046}}}
    4147
    42 === Example Configuration (`sendmail`) ===
    43 {{{
     48=== Example Configuration (`sendmail`)
     49{{{#!ini
    4450[notification]
    4551smtp_enabled = true
    … …  
    5157}}}
    5258
    53 === Customizing the e-mail subject ===
     59=== Subscriber Configuration
     60The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
     61
     62[[TracIni(section=notification-subscriber)]]
     63
     64Each user can override these defaults in his ''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
    54101The 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:
    55 {{{
    56 $prefix #$ticket.id: $summary
     102{{{#!genshi
     103${prefix} #${ticket.id}: ${summary}
    57104}}}
    58105The following variables are available in the template:
    … …  
    61108 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    62109 * `summary`: The ticket summary, with the old value if the summary was edited.
    63  * `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`.
    64 
    65 === Customizing the e-mail content ===
    66 
    67 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:
    68 
    69 {{{
    70 $ticket_body_hdr
    71 $ticket_props
     110 * `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, 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 looks like this:
     115
     116{{{#!genshi
     117${ticket_body_hdr}
     118${ticket_props}
    72119{% choose ticket.new %}\
    73120{%   when True %}\
    74 $ticket.description
     121${ticket.description}
    75122{%   end %}\
    76123{%   otherwise %}\
    … …  
    78125${_('Changes (by %(author)s):', author=change.author)}
    79126
    80 $changes_body
     127${changes_body}
    81128{%     end %}\
    82129{%     if changes_descr %}\
    … …  
    84131${_('Description changed by %(author)s:', author=change.author)}
    85132{%       end %}\
    86 $changes_descr
     133${changes_descr}
    87134--
    88135{%     end %}\
    … …  
    91138${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
    92139
    93 $change.comment
     140${change.comment}
    94141{%     end %}\
    95142{%   end %}\
    … …  
    98145--
    99146${_('Ticket URL: <%(link)s>', link=ticket.link)}
    100 $project.name <${project.url or abs_href()}>
    101 $project.descr
    102 }}}
    103 == Sample Email ==
     147${project.name} <${project.url or abs_href()}>
     148${project.descr}
     149}}}
     150
     151== Sample Email
    104152{{{
    105153#42: testing
    … …  
    112160---------------------------+------------------------------------------------
    113161Changes:
    114   * component:  changset view => search system
     162  * component:  changeset view => search system
    115163  * priority:  low => highest
    116164  * owner:  jonas => anonymous
    … …  
    127175}}}
    128176
    129 
    130 == Customizing e-mail content for MS Outlook ==
    131 
    132 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].
     177== Customizing e-mail content for MS Outlook
     178
     179MS Outlook normally presents plain text e-mails with a variable-width font, and as a result 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].
    133180
    134181Replace the following second row in the template:
    135182{{{
    136 $ticket_props
    137 }}}
    138 
    139 with this instead (''requires Python 2.6 or later''):
     183${ticket_props}
     184}}}
     185
     186with this (requires Python 2.6 or later):
    140187{{{
    141188--------------------------------------------------------------------------
    … …  
    151198}}}
    152199
    153 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.
     200The 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.
    154201{{{#!div style="margin: 1em 1.75em; border:1px dotted"
    155202{{{#!html
    … …  
    171218Changes:<br />
    172219<br />
    173 &nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
     220&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    174221&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    175222&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
    … …  
    187234}}}
    188235
    189 **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:
     236**Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which are to be part of the mail, then they have to be added to `sel`. Example:
    190237{{{
    191238   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    192239}}}
    193240
    194 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...
    195 
    196 
    197 == Using GMail as the SMTP relay host ==
    198 
    199 Use the following configuration snippet
    200 {{{
     241However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     242
     243== Using GMail as the SMTP relay host
     244
     245Use the following configuration snippet:
     246{{{#!ini
    201247[notification]
    202248smtp_enabled = true
    … …  
    209255}}}
    210256
    211 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     257where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
    212258
    213259Alternatively, you can use `smtp_port = 25`.[[br]]
    214 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 [trac:comment:2:ticket:7107 #7107] for details.
    215  
    216 == Filtering notifications for one's own changes and comments ==
    217 In Gmail, use the filter:
    218 
    219 {{{
    220 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    221 }}}
    222 
    223 to delete these notifications.
    224 
    225 In Thunderbird, there is no such solution if you use IMAP
    226 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
    227 
    228 You can also add this plugin:
    229 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    230 
    231 == Troubleshooting ==
     260You 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.
     261
     262== Troubleshooting
    232263
    233264If 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.
    234265
    235 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.
    236 
    237 === ''Permission denied'' error ===
     266Notification errors are not reported through the web interface, so the user who submits 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.
     267
     268=== ''Permission denied'' error
    238269
    239270Typical error message:
    240 {{{
     271{{{#!sh
    241272  ...
    242273  File ".../smtplib.py", line 303, in connect
    … …  
    245276}}}
    246277
    247 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.
     278This 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.
    248279
    249280Many users get confused when their manual attempts to contact the SMTP server succeed:
    250 {{{
     281{{{#!sh
    251282telnet localhost 25
    252283}}}
    253 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    254 {{{
     284This is because a regular user may connect to the SMTP server, but the web server cannot:
     285{{{#!sh
    255286sudo -u www-data telnet localhost 25
    256287}}}
    257288
    258 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.
     289In 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.
    259290
    260291Relevant ML threads:
    … …  
    262293
    263294For SELinux in Fedora 10:
    264 {{{
     295{{{#!sh
    265296$ setsebool -P httpd_can_sendmail 1
    266297}}}
    267 === ''Suspected spam'' error ===
     298
     299=== ''Suspected spam'' error
    268300
    269301Some SMTP servers may reject the notification email sent by Trac.
    270302
    271 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.
    272 
    273 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.
    274 
    275 === ''501, 5.5.4 Invalid Address'' error ===
    276 
    277 On IIS 6.0 you could get a
    278 {{{
    279 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
    280 }}}
    281 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
    282 
     303The 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.
     304
     305Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    283306
    284307----
    285 See also: TracTickets, TracIni, TracGuide
     308See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]