Changes between Version 85 and Version 86 of TracNotification
- Timestamp:
- Jan 4, 2015, 8:55:35 AM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracNotification
v85 v86 10 10 11 11 == Receiving Notification Mails == 12 When reporting a new ticket or adding a comment, enter a valid email address or your 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). 13 14 This is useful to keep up-to-date on an issue or enhancement request that interests you. 12 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. 15 13 16 14 === How to use your username to receive notification mails === 17 15 18 To receive notification mails, you can either enter a full email address or your username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page.19 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.16 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. 17 18 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. 21 19 22 20 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`'''). … … 24 22 === Ticket attachment notifications 25 23 26 Since 1.0.3 Trac will send notifications when a ticket attachment is added or deleted. Usually attachment notifications will be enabled in an environment by default. To disable the attachment notifications for an environment the `TicketAttachmentNotifier` component must be disabled .24 Since 1.0.3 Trac will send notifications when a ticket attachment is added or deleted. Usually attachment notifications will be enabled in an environment by default. To disable the attachment notifications for an environment the `TicketAttachmentNotifier` component must be disabled: 27 25 {{{#!ini 28 26 [components] … … 35 33 36 34 === Configuration Options === 37 These are the available options for the `[notification]` section in trac.ini .35 These are the available options for the `[notification]` section in trac.ini: 38 36 39 37 [[TracIni(notification)]] … … 70 68 * `prefix`: The prefix defined in `smtp_subject_prefix`. 71 69 * `summary`: The ticket summary, with the old value if the summary was edited. 72 * `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, e .g.`$ticket.milestone`.70 * `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`. 73 71 74 72 === Customizing the e-mail content === 75 73 76 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. 74 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: 77 75 78 76 {{{ … … 110 108 $project.descr 111 109 }}} 110 112 111 == Sample Email == 113 112 {{{ … … 121 120 ---------------------------+------------------------------------------------ 122 121 Changes: 123 * component: chang set view => search system122 * component: changeset view => search system 124 123 * priority: low => highest 125 124 * owner: jonas => anonymous … … 136 135 }}} 137 136 138 139 137 == Customizing e-mail content for MS Outlook == 140 138 141 Out-of-the-box, MS Outlook normally presents plain text e-mails with a variable-width font;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].139 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]. 142 140 143 141 Replace the following second row in the template: … … 146 144 }}} 147 145 148 with this instead (''requires Python 2.6 or later''):146 with this (requires Python 2.6 or later): 149 147 {{{ 150 148 -------------------------------------------------------------------------- … … 160 158 }}} 161 159 162 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.160 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. 163 161 {{{#!div style="margin: 1em 1.75em; border:1px dotted" 164 162 {{{#!html … … 180 178 Changes:<br /> 181 179 <br /> 182 * component: chang set view => search system<br />180 * component: changeset view => search system<br /> 183 181 * priority: low => highest<br /> 184 182 * owner: jonas => anonymous<br /> … … 196 194 }}} 197 195 198 **Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which shall be part of the mail they have to be added to `sel`, example:196 **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: 199 197 {{{ 200 198 sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2'] 201 199 }}} 202 200 203 However, it's not as perfect as an automatically HTML-formatted e-mail would be, but presented ticket properties are at least readable by default in MS Outlook... 204 201 However, the solution is still a workaround to an automatically HTML-formatted e-mail. 205 202 206 203 == Using GMail as the SMTP relay host == 207 204 208 Use the following configuration snippet 205 Use the following configuration snippet: 209 206 {{{ 210 207 [notification] … … 218 215 }}} 219 216 220 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]217 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com]. 221 218 222 219 Alternatively, you can use `smtp_port = 25`.[[br]] 223 You should not use `smtp_port = 465`. It will not work and your ticket submission may deadlock. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [trac:comment:2:ticket:7107 #7107] for details.220 You should not use `smtp_port = 465`. Doing so may deadlock your ticket submission. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [trac:comment:2:ticket:7107 #7107] for details. 224 221 225 222 == Filtering notifications for one's own changes and comments == 226 223 In Gmail, use the filter: 227 228 224 {{{ 229 225 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)") … … 232 228 to delete these notifications. 233 229 234 In Thunderbird, there is no such solution if you use IMAP 235 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body). 230 In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body. 236 231 237 232 You can also add this plugin: … … 242 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. 243 238 244 Notification errors are not reported through the web interface, so the user who submit 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.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. 245 240 246 241 === ''Permission denied'' error === … … 254 249 }}} 255 250 256 This error usually comes from a security settings on the server: many Linux distributions do not let the web server (Apache, ...) to post email messageto the local SMTP server.251 This error usually comes from a security settings on the server: many Linux distributions do not allow the web server (Apache, ...) to post email messages to the local SMTP server. 257 252 258 253 Many users get confused when their manual attempts to contact the SMTP server succeed: … … 260 255 telnet localhost 25 261 256 }}} 262 Th e trouble is thata regular user may connect to the SMTP server, but the web server cannot:257 This is because a regular user may connect to the SMTP server, but the web server cannot: 263 258 {{{ 264 259 sudo -u www-data telnet localhost 25 265 260 }}} 266 261 267 In such a case, you need to configure your server so that the web server is authorized to post to the SMTP server. The actual settings depend on your Linux distribution and current security policy. You may find help browsingthe Trac [trac:MailingList MailingList] archive.262 In such a case, you need to configure your server so that the web server is authorized to post to the SMTP server. The actual settings depend on your Linux distribution and current security policy. You may find help in the Trac [trac:MailingList MailingList] archive. 268 263 269 264 Relevant ML threads: … … 274 269 $ setsebool -P httpd_can_sendmail 1 275 270 }}} 271 276 272 === ''Suspected spam'' error === 277 273 278 274 Some SMTP servers may reject the notification email sent by Trac. 279 275 280 The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger ''false positive'' SPAM detection on sensitive email servers. In such an event, it is recommended tochange the default encoding to "quoted-printable" using the `mime_encoding` option.281 282 Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended tostick with the Base64 encoding.276 The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger ''false positive'' spam detection on sensitive email servers. In such an event, change the default encoding to "quoted-printable" using the `mime_encoding` option. 277 278 Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding. 283 279 284 280 === ''501, 5.5.4 Invalid Address'' error ===