Changes between Version 5 and Version 6 of TracNotification
- Timestamp:
- 2020-11-30T10:34:48-04:00 (4 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracNotification
v5 v6 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. … … 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 … … 98 101 }}} 99 102 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:103 === Customizing the email subject 104 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 105 {{{#!genshi 103 106 ${prefix} #${ticket.id}: ${summary} … … 105 108 The following variables are available in the template: 106 109 107 * `env`: The project environment object (see [trac:source:branches/1.2-stable/trac/env.py env.py]). 110 * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]). 111 * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]). 108 112 * `prefix`: The prefix defined in `smtp_subject_prefix`. 109 113 * `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 %}\ 114 * `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}`. 115 116 === Customizing the email content #CustomizingContent 117 118 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: 119 120 {{{#!jinja 121 ${ticket_body_hdr} 122 ${ticket_props} 123 # if ticket.new: 124 ${ticket.description} 125 # else: 126 # if changes_body: 125 127 ${_('Changes (by %(author)s):', author=change.author)} 126 128 127 $ changes_body128 {% end %}\ 129 {% if changes_descr %}\ 130 {% if not changes_body and not change.comment and change.author %}\ 129 ${changes_body} 130 # endif 131 # if changes_descr: 132 # if not changes_body and not change.comment and change.author: 131 133 ${_('Description changed by %(author)s:', author=change.author)} 132 {% end %}\ 133 $ changes_descr134 # endif 135 ${changes_descr} 134 136 -- 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 137 # endif 138 # if change.comment: 139 140 ${_('Comment:') if changes_body else 141 _('Comment (by %(author)s):', author=change.author)} 142 143 ${change.comment} 144 # endif 145 # endif 145 146 ${'-- '} 146 147 ${_('Ticket URL: <%(link)s>', link=ticket.link)} 147 $ project.name<${project.url or abs_href()}>148 $ project.descr148 ${project.name} <${project.url or abs_href()}> 149 ${project.descr} 149 150 }}} 150 151 … … 155 156 #42: testing 156 157 ---------------------------+------------------------------------------------ 157 Id: 42 | Status: assigned 158 Id: 42 | Status: assigned 158 159 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 160 Severity: major | Milestone: 0.9 161 Priority: lowest | Version: 0.6 162 Owner: anonymous | Reporter: jonas@example.com 162 163 ---------------------------+------------------------------------------------ 163 164 Changes: … … 191 192 }}} 192 193 193 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http ://gmail.com].194 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com]. 194 195 195 196 Alternatively, you can use `smtp_port = 25`.[[br]]
