Changes between Version 6 and Version 7 of TracNotification


Ignore:
Timestamp:
Aug 24, 2019, 7:16:43 AM (7 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v6 v7  
    44Trac supports notification of ticket changes via email.
    55
    6 Email 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 
    8 Disabled by default, notification can be activated and configured in [TracIni trac.ini].
     6Email 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
     8Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
    99
    1010== Receiving Notification Mails
     
    1313=== How to use your username to receive notification mails
    1414
    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 your [/prefs preferences].
     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.
    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.
     
    2929== Configuring SMTP Notification
    3030
    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.
     31'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    3232
    3333=== Configuration Options
     
    5858
    5959=== Subscriber Configuration
    60 The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
     60The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
    6161
    6262[[TracIni(section=notification-subscriber)]]
    6363
    64 Each user can override these defaults in their ''Notifications'' preferences.
     64Each user can override these defaults in his ''Notifications'' preferences.
    6565
    6666For 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.
    6767
    68 The 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 
    70 The 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]
    84 always_notify_owner = TicketOwnerSubscriber
    85 always_notify_owner.distributor = email
    86 always_notify_owner.priority = 100
    87 always_notify_owner.adverb = always
    88 always_notify_owner.format = text/plain
    89 
    90 always_notify_previous_updater = TicketPreviousUpdatersSubscriber
    91 
    92 never_notify_updater = TicketUpdaterSubscriber
    93 never_notify_updater.adverb = never
    94 never_notify_updater.priority = 0
    95 
    96 notify_cc_html = CarbonCopySubscriber
    97 notify_cc_html.format = text/html
    98 }}}
    99 
    10068=== Customizing the e-mail subject
    101 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:
     69The e-mail subject can be customized with the `ticket_subject_template` option, which contains a [http://genshi.edgewall.org/wiki/Documentation/text-templates.html text template] snippet. The default value is:
    10270{{{#!genshi
    10371${prefix} #${ticket.id}: ${summary}
     
    10573The following variables are available in the template:
    10674
    107  * `env`: The project environment object (see [trac:source:/trunk/trac/env.py env.py]).
     75 * `changes`: The ticket changes (prepared by [trac:source:/trunk/trac/ticket/model.py Ticket.get_change]).
     76 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
    10877 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    10978 * `summary`: The ticket summary, with the old value if the summary was edited.
    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}`.
     79 * `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`.
    11180
    11281=== Customizing the e-mail content
    11382
    114 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 is:
     83The 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:
    11584
    11685{{{#!genshi
    117 ${ticket_body_hdr}
    118 ${ticket_props}
    119 # if ticket.new:
    120 ${ticket.description}
    121 # else:
    122 #   if changes_body:
     86$ticket_body_hdr
     87$ticket_props
     88{% choose ticket.new %}\
     89{%   when True %}\
     90$ticket.description
     91{%   end %}\
     92{%   otherwise %}\
     93{%     if changes_body %}\
    12394${_('Changes (by %(author)s):', author=change.author)}
    12495
    125 ${changes_body}
    126 #   endif
    127 #   if changes_descr:
    128 #     if not changes_body and not change.comment and change.author:
     96$changes_body
     97{%     end %}\
     98{%     if changes_descr %}\
     99{%       if not changes_body and not change.comment and change.author %}\
    129100${_('Description changed by %(author)s:', author=change.author)}
    130 #     endif
    131 ${changes_descr}
     101{%       end %}\
     102$changes_descr
    132103--
    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 --
     104{%     end %}\
     105{%     if change.comment %}\
     106
     107${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     108
     109$change.comment
     110{%     end %}\
     111{%   end %}\
     112{% end %}\
     113
     114--
    143115${_('Ticket URL: <%(link)s>', link=ticket.link)}
    144 ${project.name} <${project.url or abs_href()}>
    145 ${project.descr}
    146 }}}
    147 
    148 See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
     116$project.name <${project.url or abs_href()}>
     117$project.descr
     118}}}
    149119
    150120== Sample Email
     
    174144}}}
    175145
     146== Customizing e-mail content for MS Outlook
     147
     148MS 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].
     149
     150Replace the following second row in the template:
     151{{{
     152$ticket_props
     153}}}
     154
     155with this (requires Python 2.6 or later):
     156{{{
     157--------------------------------------------------------------------------
     158{% with
     159   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     160         [c.strip() for c in
     161          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     162   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     163          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     164${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     165{% end %}\
     166--------------------------------------------------------------------------
     167}}}
     168
     169The 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.
     170{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     171{{{#!html
     172#42: testing<br />
     173--------------------------------------------------------------------------<br />
     174<table cellpadding=0>
     175<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     176<tr><td>Owner:</td><td>anonymous</td></tr>
     177<tr><td>Type:</td><td>defect</td></tr>
     178<tr><td>Status:</td><td>assigned</td></tr>
     179<tr><td>Priority:</td><td>lowest</td></tr>
     180<tr><td>Milestone:</td><td>0.9</td></tr>
     181<tr><td>Component:</td><td>report system</td></tr>
     182<tr><td>Severity:</td><td>major</td></tr>
     183<tr><td>Resolution:</td><td> </td></tr>
     184<tr><td>Keywords:</td><td> </td></tr>
     185</table>
     186--------------------------------------------------------------------------<br />
     187Changes:<br />
     188<br />
     189&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     190&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     191&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     192&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     194&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     195<br />
     196Comment:<br />
     197I'm interested too!<br />
     198<br />
     199--<br />
     200Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     201My Project &lt;http://myproj.example.com/&gt;<br />
     202}}}
     203}}}
     204
     205**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:
     206{{{
     207   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     208}}}
     209
     210However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     211
    176212== Using GMail as the SMTP relay host
    177213
     
    195231== Troubleshooting
    196232
    197 If notifications are not working, inspect the [TracLogging log] for error messages.
    198 
    199 Notification 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.
     233If 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.
     234
     235Notification 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.
    200236
    201237=== ''Permission denied'' error