Changes between Version 4 and Version 5 of TracNotification


Ignore:
Timestamp:
Jun 27, 2018, 1:17:52 PM (12 months 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
    44Trac supports notification of ticket changes via email.
    55
    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 ==
     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
    1111When 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.
    1212
    13 === How to use your username to receive notification mails ===
    14 
    15 To 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.
     13=== How to use your username to receive notification mails
     14
     15To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in your [/prefs preferences].
    1616
    1717Alternatively, 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.
     
    2727}}}
    2828
    29 == Configuring SMTP Notification ==
    30 
    31 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    32 
    33 === Configuration Options ===
     29== Configuring SMTP Notification
     30
     31'''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated.
     32
     33=== Configuration Options
    3434These are the available options for the `[notification]` section in trac.ini:
    3535
    36 [[TracIni(notification)]]
    37 
    38 === Example Configuration (SMTP) ===
    39 {{{
     36[[TracIni(section=notification)]]
     37
     38=== Example Configuration (SMTP)
     39{{{#!ini
    4040[notification]
    4141smtp_enabled = true
     
    4646}}}
    4747
    48 === Example Configuration (`sendmail`) ===
    49 {{{
     48=== Example Configuration (`sendmail`)
     49{{{#!ini
    5050[notification]
    5151smtp_enabled = true
     
    5757}}}
    5858
    59 === Customizing the e-mail subject ===
     59=== Subscriber Configuration
     60The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
     61
     62[[TracIni(section=notification-subscriber)]]
     63
     64Each user can override these defaults in their ''Notifications'' preferences.
     65
     66For example to unsubscribe from notifications for one's own changes and comments, the rule "Never notify: I update a ticket" should be added above other subscription rules.
     67
     68The subscription rule name on the left side of the `=` can be anything, it has no meaning outside this configuration file. The subscriber name on the right side of the `=` must be one of the subscribers listed in the above table.
     69
     70The following attributes of default subscriptions can be configured:
     71* `.distributor` (Default: `email`)
     72  * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.
     73* `.priority` (Default: `100`)
     74  * Smaller values override larger values.
     75  * If you use `0`, then users will not be able to override this rule.
     76* `.adverb` (Default: `always`)
     77  * `never` can be used to silence other subscription rules with higher values.
     78* `.format` (Default: `text/plain`)
     79  * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.
     80
     81=== Example Configuration (default subscriptions)
     82{{{#!ini
     83[notification-subscriber]
     84always_notify_owner = TicketOwnerSubscriber
     85always_notify_owner.distributor = email
     86always_notify_owner.priority = 100
     87always_notify_owner.adverb = always
     88always_notify_owner.format = text/plain
     89
     90always_notify_previous_updater = TicketPreviousUpdatersSubscriber
     91
     92never_notify_updater = TicketUpdaterSubscriber
     93never_notify_updater.adverb = never
     94never_notify_updater.priority = 0
     95
     96notify_cc_html = CarbonCopySubscriber
     97notify_cc_html.format = text/html
     98}}}
     99
     100=== Customizing the e-mail subject
    60101The 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:
    61 {{{
    62 $prefix #$ticket.id: $summary
     102{{{#!genshi
     103${prefix} #${ticket.id}: ${summary}
    63104}}}
    64105The following variables are available in the template:
    65106
    66  * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     107 * `env`: The project environment object (see [trac:source:/trunk/trac/env.py env.py]).
    67108 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    68109 * `summary`: The ticket summary, with the old value if the summary was edited.
    69  * `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`.
    70 
    71 === Customizing the e-mail content ===
    72 
    73 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:
    74 
    75 {{{
    76 $ticket_body_hdr
    77 $ticket_props
    78 {% choose ticket.new %}\
    79 {%   when True %}\
    80 $ticket.description
    81 {%   end %}\
    82 {%   otherwise %}\
    83 {%     if changes_body %}\
     110 * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/model.py model.py]). Individual ticket fields can be accessed by appending the field name separated by a dot, eg `${ticket.milestone}`.
     111
     112=== Customizing the e-mail content
     113
     114The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. You can add your own version of this template by adding a `ticket_notify_email.txt` to the templates directory of your environment. The default is:
     115
     116{{{#!genshi
     117${ticket_body_hdr}
     118${ticket_props}
     119# if ticket.new:
     120${ticket.description}
     121# else:
     122#   if changes_body:
    84123${_('Changes (by %(author)s):', author=change.author)}
    85124
    86 $changes_body
    87 {%     end %}\
    88 {%     if changes_descr %}\
    89 {%       if not changes_body and not change.comment and change.author %}\
     125${changes_body}
     126#   endif
     127#   if changes_descr:
     128#     if not changes_body and not change.comment and change.author:
    90129${_('Description changed by %(author)s:', author=change.author)}
    91 {%       end %}\
    92 $changes_descr
     130#     endif
     131${changes_descr}
    93132--
    94 {%     end %}\
    95 {%     if change.comment %}\
    96 
    97 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
    98 
    99 $change.comment
    100 {%     end %}\
    101 {%   end %}\
    102 {% end %}\
    103 
    104 --
     133#   endif
     134#   if change.comment:
     135
     136${_('Comment:') if changes_body else
     137  _('Comment (by %(author)s):', author=change.author)}
     138
     139${change.comment}
     140#   endif
     141# endif
     142--
    105143${_('Ticket URL: <%(link)s>', link=ticket.link)}
    106 $project.name <${project.url or abs_href()}>
    107 $project.descr
    108 }}}
    109 
    110 == Sample Email ==
     144${project.name} <${project.url or abs_href()}>
     145${project.descr}
     146}}}
     147
     148See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
     149
     150== Sample Email
    111151{{{
    112152#42: testing
     
    134174}}}
    135175
    136 == Customizing e-mail content for MS Outlook ==
    137 
    138 MS 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].
    139 
    140 Replace the following second row in the template:
    141 {{{
    142 $ticket_props
    143 }}}
    144 
    145 with this (requires Python 2.6 or later):
    146 {{{
    147 --------------------------------------------------------------------------
    148 {% with
    149    pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
    150          [c.strip() for c in
    151           ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
    152    sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
    153           'Component', 'Severity', 'Resolution', 'Keywords'] %}\
    154 ${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
    155 {% end %}\
    156 --------------------------------------------------------------------------
    157 }}}
    158 
    159 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.
    160 {{{#!div style="margin: 1em 1.75em; border:1px dotted"
    161 {{{#!html
    162 #42: testing<br />
    163 --------------------------------------------------------------------------<br />
    164 <table cellpadding=0>
    165 <tr><td>Reporter:</td><td>jonas@example.com</td></tr>
    166 <tr><td>Owner:</td><td>anonymous</td></tr>
    167 <tr><td>Type:</td><td>defect</td></tr>
    168 <tr><td>Status:</td><td>assigned</td></tr>
    169 <tr><td>Priority:</td><td>lowest</td></tr>
    170 <tr><td>Milestone:</td><td>0.9</td></tr>
    171 <tr><td>Component:</td><td>report system</td></tr>
    172 <tr><td>Severity:</td><td>major</td></tr>
    173 <tr><td>Resolution:</td><td> </td></tr>
    174 <tr><td>Keywords:</td><td> </td></tr>
    175 </table>
    176 --------------------------------------------------------------------------<br />
    177 Changes:<br />
    178 <br />
    179 &nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    180 &nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    181 &nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
    182 &nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
    183 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
    184 &nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
    185 <br />
    186 Comment:<br />
    187 I'm interested too!<br />
    188 <br />
    189 --<br />
    190 Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
    191 My Project &lt;http://myproj.example.com/&gt;<br />
    192 }}}
    193 }}}
    194 
    195 **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:
    196 {{{
    197    sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    198 }}}
    199 
    200 However, the solution is still a workaround to an automatically HTML-formatted e-mail.
    201 
    202 == Using GMail as the SMTP relay host ==
     176== Using GMail as the SMTP relay host
    203177
    204178Use the following configuration snippet:
    205 {{{
     179{{{#!ini
    206180[notification]
    207181smtp_enabled = true
     
    218192Alternatively, you can use `smtp_port = 25`.[[br]]
    219193You 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.
    220  
    221 == Filtering notifications for one's own changes and comments ==
    222 In Gmail, use the filter:
    223 {{{
    224 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    225 }}}
    226 
    227 to delete these notifications.
    228 
    229 In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
    230 
    231 You can also add this plugin:
    232 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    233 
    234 == Troubleshooting ==
    235 
    236 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.
    237 
    238 Notification 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.
    239 
    240 === ''Permission denied'' error ===
     194
     195== Troubleshooting
     196
     197If notifications are not working, inspect the [TracLogging log] for error messages.
     198
     199Notification errors are not always reported through the web interface, so the user who submits a change or creates a ticket may not get notified about a notification failure. The Trac administrator needs to look at the log to find the error message and traceback.
     200
     201=== ''Permission denied'' error
    241202
    242203Typical error message:
    243 {{{
     204{{{#!sh
    244205  ...
    245206  File ".../smtplib.py", line 303, in connect
     
    251212
    252213Many users get confused when their manual attempts to contact the SMTP server succeed:
    253 {{{
     214{{{#!sh
    254215telnet localhost 25
    255216}}}
    256217This is because a regular user may connect to the SMTP server, but the web server cannot:
    257 {{{
     218{{{#!sh
    258219sudo -u www-data telnet localhost 25
    259220}}}
     
    265226
    266227For SELinux in Fedora 10:
    267 {{{
     228{{{#!sh
    268229$ setsebool -P httpd_can_sendmail 1
    269230}}}
    270231
    271 === ''Suspected spam'' error ===
     232=== ''Suspected spam'' error
    272233
    273234Some SMTP servers may reject the notification email sent by Trac.