Edgewall Software

Changes between Version 6 and Version 7 of 1.3/TracNotification


Ignore:
Timestamp:
Oct 15, 2019, 6:28:08 AM (5 years ago)
Author:
trac
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • 1.3/TracNotification

    v6 v7  
    33[[TranslatedPages]]
    44
    5 Trac supports notification of ticket changes via email. 
    6 
    7 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.
    8 
    9 Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
     5Trac supports notification of ticket changes via email.
     6
     7Email 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.
     8
     9Disabled by default, notification can be activated and configured in [TracIni trac.ini].
    1010
    1111== Receiving Notification Mails
    … …  
    1717=== How to use your username to receive notification mails
    1818
    19 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.
     19To 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].
    2020
    2121Alternatively, 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.
    … …  
    3333== Configuring SMTP Notification
    3434
    35 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
     35'''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated.
    3636
    3737=== Configuration Options
    … …  
    6262
    6363=== Subscriber Configuration
    64 The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
     64The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
    6565
    6666[[TracIni(section=notification-subscriber)]]
    6767
    68 Each user can override these defaults in his ''Notifications'' preferences.
     68Each user can override these defaults in their ''Notifications'' preferences.
    6969
    7070For 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.
    7171
    72 === Customizing the e-mail subject
    73 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 text template] snippet. The default value is:
     72The 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.
     73
     74The following attributes of default subscriptions can be configured:
     75* `.distributor` (Default: `email`)
     76  * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.
     77* `.priority` (Default: `100`)
     78  * Smaller values override larger values.
     79  * If you use `0`, then users will not be able to override this rule.
     80* `.adverb` (Default: `always`)
     81  * `never` can be used to silence other subscription rules with higher values.
     82* `.format` (Default: `text/plain`)
     83  * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.
     84
     85=== Example Configuration (default subscriptions)
     86{{{#!ini
     87[notification-subscriber]
     88always_notify_owner = TicketOwnerSubscriber
     89always_notify_owner.distributor = email
     90always_notify_owner.priority = 100
     91always_notify_owner.adverb = always
     92always_notify_owner.format = text/plain
     93
     94always_notify_previous_updater = TicketPreviousUpdatersSubscriber
     95
     96never_notify_updater = TicketUpdaterSubscriber
     97never_notify_updater.adverb = never
     98never_notify_updater.priority = 0
     99
     100notify_cc_html = CarbonCopySubscriber
     101notify_cc_html.format = text/html
     102}}}
     103
     104=== Customizing the email subject
     105The 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:
    74106{{{#!genshi
    75107${prefix} #${ticket.id}: ${summary}
    … …  
    77109The following variables are available in the template:
    78110
    79  * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]). 
     111 * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]).
    80112 * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]).
    81113 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    … …  
    83115 * `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`.
    84116
    85 === Customizing the e-mail content
    86 
    87 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:
     117=== Customizing the email content
     118
     119The 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:
    88120
    89121{{{#!genshi
    … …  
    109141{%     if change.comment %}\
    110142
    111 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     143${_('Comment:') if changes_body else _('Comment (by %(author)s):', author=change.author)}
    112144
    113145$change.comment
    … …  
    116148{% end %}\
    117149
    118 --
     150${'-- '}
    119151${_('Ticket URL: <%(link)s>', link=ticket.link)}
    120152$project.name <${project.url or abs_href()}>
    121153$project.descr
    122154}}}
     155
     156See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
    123157
    124158== Sample Email
    … …  
    126160#42: testing
    127161---------------------------+------------------------------------------------
    128        Id:  42             |      Status:  assigned               
     162       Id:  42             |      Status:  assigned
    129163Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
    130  Severity:  major          |   Milestone:  0.9                     
    131  Priority:  lowest         |     Version:  0.6                     
    132     Owner:  anonymous      |    Reporter:  jonas@example.com               
     164 Severity:  major          |   Milestone:  0.9
     165 Priority:  lowest         |     Version:  0.6
     166    Owner:  anonymous      |    Reporter:  jonas@example.com
    133167---------------------------+------------------------------------------------
    134168Changes:
    … …  
    148182}}}
    149183
    150 == Customizing e-mail content for MS Outlook
    151 
    152 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].
    153 
    154 Replace the following second row in the template:
    155 {{{
    156 $ticket_props
    157 }}}
    158 
    159 with this (requires Python 2.6 or later):
    160 {{{
    161 --------------------------------------------------------------------------
    162 {% with
    163    pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
    164          [c.strip() for c in
    165           ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
    166    sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
    167           'Component', 'Severity', 'Resolution', 'Keywords'] %}\
    168 ${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
    169 {% end %}\
    170 --------------------------------------------------------------------------
    171 }}}
    172 
    173 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.
    174 {{{#!div style="margin: 1em 1.75em; border:1px dotted"
    175 {{{#!html
    176 #42: testing<br />
    177 --------------------------------------------------------------------------<br />
    178 <table cellpadding=0>
    179 <tr><td>Reporter:</td><td>jonas@example.com</td></tr>
    180 <tr><td>Owner:</td><td>anonymous</td></tr>
    181 <tr><td>Type:</td><td>defect</td></tr>
    182 <tr><td>Status:</td><td>assigned</td></tr>
    183 <tr><td>Priority:</td><td>lowest</td></tr>
    184 <tr><td>Milestone:</td><td>0.9</td></tr>
    185 <tr><td>Component:</td><td>report system</td></tr>
    186 <tr><td>Severity:</td><td>major</td></tr>
    187 <tr><td>Resolution:</td><td> </td></tr>
    188 <tr><td>Keywords:</td><td> </td></tr>
    189 </table>
    190 --------------------------------------------------------------------------<br />
    191 Changes:<br />
    192 <br />
    193 &nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    194 &nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    195 &nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
    196 &nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
    197 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
    198 &nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
    199 <br />
    200 Comment:<br />
    201 I'm interested too!<br />
    202 <br />
    203 --<br />
    204 Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
    205 My Project &lt;http://myproj.example.com/&gt;<br />
    206 }}}
    207 }}}
    208 
    209 **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:
    210 {{{
    211    sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    212 }}}
    213 
    214 However, the solution is still a workaround to an automatically HTML-formatted e-mail.
    215 
    216184== Using GMail as the SMTP relay host
    217185
    … …  
    228196}}}
    229197
    230 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     198where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com].
    231199
    232200Alternatively, you can use `smtp_port = 25`.[[br]]
    … …  
    235203== Troubleshooting
    236204
    237 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.
    238 
    239 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.
     205If notifications are not working, inspect the [TracLogging log] for error messages.
     206
     207Notification 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.
    240208
    241209=== ''Permission denied'' error