Changes between Version 3 and Version 4 of TracNotification
- Timestamp:
- Sep 24, 2024, 8:54:45 AM (3 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracNotification
v3 v4 2 2 [[TracGuideToc]] 3 3 4 Trac supports notification of ticket changes via email. 4 Trac supports notification of ticket changes via email. 5 5 6 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. … … 9 9 10 10 == Receiving Notification Mails 11 When 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. 11 When 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 may send you an email when changes are made to the ticket, depending on how your notification preferences are configured. 12 13 Permission groups can also be entered in the CC field, 14 to notify all members of the group. 12 15 13 16 === How to use your username to receive notification mails 14 17 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]. 18 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]. 16 19 17 20 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. 18 21 19 When 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 22 When 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`'''). 20 23 21 24 === Ticket attachment notifications … … 29 32 == Configuring SMTP Notification 30 33 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. 34 '''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 35 33 36 === Configuration Options … … 70 73 The following attributes of default subscriptions can be configured: 71 74 * `.distributor` (Default: `email`) 72 * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.75 * Other values require plugins. For example `on-site` requires [https://trac-hacks.org/wiki/OnSiteNotificationsPlugin OnSiteNotificationsPlugin]. 73 76 * `.priority` (Default: `100`) 74 77 * Smaller values override larger values. … … 77 80 * `never` can be used to silence other subscription rules with higher values. 78 81 * `.format` (Default: `text/plain`) 79 * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.82 * Other values require plugins. For example `text/html` requires [https://trac-hacks.org/wiki/TracHtmlNotificationPlugin TracHtmlNotificationPlugin]. 80 83 81 84 === Example Configuration (default subscriptions) 85 86 This example implements the often desired 87 //Never Notify Updater// behavior by setting 88 the priority of that rule to the highest value, 89 thereby taking precedence over other rules. 90 82 91 {{{#!ini 83 92 [notification-subscriber] … … 98 107 }}} 99 108 100 === Customizing the e -mail subject101 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:109 === Customizing the email subject 110 The 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: 102 111 {{{#!genshi 103 112 ${prefix} #${ticket.id}: ${summary} … … 105 114 The following variables are available in the template: 106 115 107 * `env`: The project environment object (see [trac:source:branches/1.2-stable/trac/env.py env.py]). 116 * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]). 117 * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]). 108 118 * `prefix`: The prefix defined in `smtp_subject_prefix`. 109 119 * `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}`. 111 112 === Customizing the e-mail content 113 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: 115 116 {{{#!genshi 117 $ticket_body_hdr 118 $ticket_props 119 {% choose ticket.new %}\ 120 {% when True %}\ 121 $ticket.description 122 {% end %}\ 123 {% otherwise %}\ 124 {% if changes_body %}\ 120 * `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}`. 121 122 === Customizing the email content #CustomizingContent 123 124 The 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: 125 126 {{{#!jinja 127 ${ticket_body_hdr} 128 ${ticket_props} 129 # if ticket.new: 130 ${ticket.description} 131 # else: 132 # if changes_body: 125 133 ${_('Changes (by %(author)s):', author=change.author)} 126 134 127 $ changes_body128 {% end %}\ 129 {% if changes_descr %}\ 130 {% if not changes_body and not change.comment and change.author %}\ 135 ${changes_body} 136 # endif 137 # if changes_descr: 138 # if not changes_body and not change.comment and change.author: 131 139 ${_('Description changed by %(author)s:', author=change.author)} 132 {% end %}\ 133 $ changes_descr140 # endif 141 ${changes_descr} 134 142 -- 135 {% end %}\ 136 {% if change.comment %}\ 137 138 ${_('Comment:') if changes_body else _('Comment (by %(author)s):', author=change.author)} 139 140 $change.comment 141 {% end %}\ 142 {% end %}\ 143 {% end %}\ 144 143 # endif 144 # if change.comment: 145 146 ${_('Comment:') if changes_body else 147 _('Comment (by %(author)s):', author=change.author)} 148 149 ${change.comment} 150 # endif 151 # endif 145 152 ${'-- '} 146 153 ${_('Ticket URL: <%(link)s>', link=ticket.link)} 147 $ project.name<${project.url or abs_href()}>148 $ project.descr154 ${project.name} <${project.url or abs_href()}> 155 ${project.descr} 149 156 }}} 150 157 … … 155 162 #42: testing 156 163 ---------------------------+------------------------------------------------ 157 Id: 42 | Status: assigned 164 Id: 42 | Status: assigned 158 165 Component: report system | Modified: Fri Apr 9 00:04:31 2004 159 Severity: major | Milestone: 0.9 160 Priority: lowest | Version: 0.6 161 Owner: anonymous | Reporter: jonas@example.com 166 Severity: major | Milestone: 0.9 167 Priority: lowest | Version: 0.6 168 Owner: anonymous | Reporter: jonas@example.com 162 169 ---------------------------+------------------------------------------------ 163 170 Changes: … … 191 198 }}} 192 199 193 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http ://gmail.com].200 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com]. 194 201 195 202 Alternatively, you can use `smtp_port = 25`.[[br]] … … 202 209 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. 203 210 204 === ''Permission denied''error211 === Permission denied error 205 212 206 213 Typical error message: … … 233 240 }}} 234 241 235 === ''Suspected spam''error242 === Suspected spam error 236 243 237 244 Some SMTP servers may reject the notification email sent by Trac. … … 240 247 241 248 Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding. 249 250 === Emails not sent 251 252 If you are switching back to using Trac to send emails from, say, the [https://trac-hacks.org/wiki/AnnouncerPlugin AnnouncerPlugin], be sure to enable `EmailDistributor` in your Trac configuration. It may have been disabled when using an email plugin. There may be no message in the Trac log when all is good to go, but the actual sending is disabled. 242 253 243 254 ----
