close Warning: Can't synchronize with repository "(default)" (/common/SVN/wimax does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 3 and Version 4 of TracNotification


Ignore:
Timestamp:
Jan 30, 2019, 11:46:28 PM (19 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v3 v4  
    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
    3434These are the available options for the `[notification]` section in trac.ini:
    3535
    36 [[TracIni(section=notification)]]
     36[[TracIni(notification)]]
    3737
    3838=== Example Configuration (SMTP)
     
    5858
    5959=== Subscriber Configuration
    60 The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
    61 
    62 [[TracIni(section=notification-subscriber)]]
    63 
    64 Each user can override these defaults in their ''Notifications'' preferences.
     60The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
     61
     62[[TracIni(notification-subscriber)]]
     63
     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.
    67 
    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 }}}
    9967
    10068=== Customizing the e-mail subject
    10169The 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:
    10270{{{#!genshi
    103 ${prefix} #${ticket.id}: ${summary}
     71$prefix #$ticket.id: $summary
    10472}}}
    10573The following variables are available in the template:
    10674
    107  * `env`: The project environment object (see [trac:source:branches/1.2-stable/trac/env.py env.py]).
     75 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
    10876 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    10977 * `summary`: The ticket summary, with the old value if the summary was edited.
    110  * `ticket`: The ticket model object (see [trac:source:branches/1.2-stable/trac/ticket/model.py model.py]). Individual ticket fields can be accessed by appending the field name separated by a dot, eg `${ticket.milestone}`.
     78 * `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`.
    11179
    11280=== Customizing the e-mail content
    11381
    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:
     82The 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:
    11583
    11684{{{#!genshi
     
    136104{%     if change.comment %}\
    137105
    138 ${_('Comment:') if changes_body else _('Comment (by %(author)s):', author=change.author)}
     106${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
    139107
    140108$change.comment
     
    143111{% end %}\
    144112
    145 ${'-- '}
     113--
    146114${_('Ticket URL: <%(link)s>', link=ticket.link)}
    147115$project.name <${project.url or abs_href()}>
    148116$project.descr
    149117}}}
    150 
    151 See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
    152118
    153119== Sample Email
     
    177143}}}
    178144
     145== Customizing e-mail content for MS Outlook
     146
     147MS 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].
     148
     149Replace the following second row in the template:
     150{{{
     151$ticket_props
     152}}}
     153
     154with this (requires Python 2.6 or later):
     155{{{
     156--------------------------------------------------------------------------
     157{% with
     158   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     159         [c.strip() for c in
     160          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     161   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     162          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     163${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     164{% end %}\
     165--------------------------------------------------------------------------
     166}}}
     167
     168The 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.
     169{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     170{{{#!html
     171#42: testing<br />
     172--------------------------------------------------------------------------<br />
     173<table cellpadding=0>
     174<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     175<tr><td>Owner:</td><td>anonymous</td></tr>
     176<tr><td>Type:</td><td>defect</td></tr>
     177<tr><td>Status:</td><td>assigned</td></tr>
     178<tr><td>Priority:</td><td>lowest</td></tr>
     179<tr><td>Milestone:</td><td>0.9</td></tr>
     180<tr><td>Component:</td><td>report system</td></tr>
     181<tr><td>Severity:</td><td>major</td></tr>
     182<tr><td>Resolution:</td><td> </td></tr>
     183<tr><td>Keywords:</td><td> </td></tr>
     184</table>
     185--------------------------------------------------------------------------<br />
     186Changes:<br />
     187<br />
     188&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     189&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     190&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     191&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     193&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     194<br />
     195Comment:<br />
     196I'm interested too!<br />
     197<br />
     198--<br />
     199Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     200My Project &lt;http://myproj.example.com/&gt;<br />
     201}}}
     202}}}
     203
     204**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:
     205{{{
     206   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     207}}}
     208
     209However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     210
    179211== Using GMail as the SMTP relay host
    180212
     
    198230== Troubleshooting
    199231
    200 If notifications are not working, inspect the [TracLogging log] for error messages.
    201 
    202 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.
     232If 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.
     233
     234Notification 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.
    203235
    204236=== ''Permission denied'' error