Changes between Initial Version and Version 1 of TracNotification

Show
Ignore:
Timestamp:
01/19/2011 06:46:15 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v1 v1  
     1= Email Notification of Ticket Changes = 
     2[[TracGuideToc]] 
     3 
     4[[PageOutline]] 
     5 
     6Trac supports notification about ticket changes via email.  
     7 
     8Email 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. 
     9 
     10Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini]. 
     11 
     12== Receiving Notification Mails == 
     13When 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). 
     14 
     15This is useful to keep up-to-date on an issue or enhancement request that interests you. 
     16 
     17=== How to use your username to receive notification mails === 
     18 
     19To 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.  
     20 
     21Alternatively, 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. 
     22 
     23== Configuring SMTP Notification == 
     24 
     25'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].  
     26 
     27=== Configuration Options === 
     28These are the available options for the `[notification]` section in trac.ini. 
     29 
     30 * '''`smtp_enabled`''': Enable email notification. 
     31 * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails. 
     32 * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails. 
     33 * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails. 
     34 * '''`smtp_default_domain`''': (''since 0.10'') Append the specified domain to addresses that do not contain one. Fully qualified addresses are not modified. The default domain is appended to all username/login for which an email address cannot be found from the user settings. 
     35 * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' 
     36 * '''`smtp_always_bcc`''': (''since 0.10'') List of email addresses to always send notifications to, but keeps addresses not visible from other recipients of the notification email  
     37 * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default. 
     38 * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false). 
     39 * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false). 
     40 * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true). 
     41 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). 
     42 * '''`use_short_addr`''': (''since 0.10'') Enable delivery of notifications to addresses that do not contain a domain (i.e. do not end with ''@<domain.com>'').This option is useful for intranets, where the SMTP server can handle local addresses and map the username/login to a local mailbox. See also `smtp_default_domain`. Do not use this option with a public SMTP server.  
     43 * '''`mime_encoding`''': (''since 0.10'') E-mail notifications are always sent in 7-bit mode. This option allows to select the MIME encoding scheme. Supported values: 
     44   * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. 
     45   * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64) 
     46   * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.  
     47 * '''`ticket_subject_template`''': (''since 0.11'') A [http://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet used to get the notification subject. 
     48 
     49Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
     50 
     51The following options are specific to email delivery through SMTP. 
     52 * '''`smtp_server`''': SMTP server used for notification messages. 
     53 * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server. 
     54 * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account. 
     55 * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account. 
     56 * '''`use_tls`''': (''since 0.10'') Toggle to send notifications via a SMTP server using [http://en.wikipedia.org/wiki/Transport_Layer_Security TLS], such as GMail. 
     57 
     58 
     59=== Example Configuration (SMTP) === 
     60{{{ 
     61[notification] 
     62smtp_enabled = true 
     63smtp_server = mail.example.com 
     64smtp_from = notifier@example.com 
     65smtp_replyto = myproj@projects.example.com 
     66smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com 
     67}}} 
     68 
     69 
     70=== Customizing the e-mail subject === 
     71The 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: 
     72{{{ 
     73$prefix #$ticket.id: $summary 
     74}}} 
     75The following variables are available in the template: 
     76 
     77 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]). 
     78 * `prefix`: The prefix defined in `smtp_subject_prefix`. 
     79 * `summary`: The ticket summary, with the old value if the summary was edited. 
     80 * `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`. 
     81 
     82=== Customizing the e-mail content === 
     83 
     84The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`.  The default looks like this: 
     85 
     86{{{ 
     87$ticket_body_hdr 
     88$ticket_props 
     89#choose ticket.new 
     90  #when True 
     91$ticket.description 
     92  #end 
     93  #otherwise 
     94    #if changes_body 
     95Changes (by $change.author): 
     96 
     97$changes_body 
     98    #end 
     99    #if changes_descr 
     100      #if not changes_body and not change.comment and change.author 
     101Description changed by $change.author: 
     102      #end 
     103$changes_descr 
     104-- 
     105    #end 
     106    #if change.comment 
     107 
     108Comment${not changes_body and '(by %s)' % change.author or ''}: 
     109 
     110$change.comment 
     111    #end 
     112  #end 
     113#end 
     114 
     115--  
     116Ticket URL: <$ticket.link> 
     117$project.name <${project.url or abs_href()}> 
     118$project.descr 
     119}}} 
     120== Sample Email == 
     121{{{ 
     122#42: testing 
     123---------------------------+------------------------------------------------ 
     124       Id:  42             |      Status:  assigned                 
     125Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004 
     126 Severity:  major          |   Milestone:  0.9                      
     127 Priority:  lowest         |     Version:  0.6                      
     128    Owner:  anonymous      |    Reporter:  jonas@example.com                
     129---------------------------+------------------------------------------------ 
     130Changes: 
     131  * component:  changset view => search system 
     132  * priority:  low => highest 
     133  * owner:  jonas => anonymous 
     134  * cc:  daniel@example.com => 
     135         daniel@example.com, jonas@example.com 
     136  * status:  new => assigned 
     137 
     138Comment: 
     139I'm interested too! 
     140 
     141-- 
     142Ticket URL: <http://example.com/trac/ticket/42> 
     143My Project <http://myproj.example.com/> 
     144}}} 
     145 
     146== Using GMail as the SMTP relay host == 
     147 
     148Use the following configuration snippet 
     149{{{ 
     150[notification] 
     151smtp_enabled = true 
     152use_tls = true 
     153mime_encoding = base64 
     154smtp_server = smtp.gmail.com 
     155smtp_port = 587 
     156smtp_user = user 
     157smtp_password = password 
     158}}} 
     159 
     160where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com] 
     161 
     162Alternatively, you can use `smtp_port = 25`.[[br]] 
     163You 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 [comment:ticket:7107:2 #7107] for details. 
     164  
     165== Filtering notifications for one's own changes == 
     166In Gmail, use the filter: 
     167 
     168{{{ 
     169from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)") 
     170}}} 
     171 
     172For Trac .10, use the filter: 
     173{{{ 
     174from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)") 
     175}}} 
     176 
     177to delete these notifications. 
     178 
     179In Thunderbird, there is no such solution if you use IMAP 
     180(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body). 
     181 
     182The best you can do is to set "always_notify_updater" in conf/trac.ini to false. 
     183You will however still get an email if you comment a ticket that you own or have reported. 
     184 
     185You can also add this plugin: 
     186http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin 
     187 
     188== Troubleshooting == 
     189 
     190If 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. 
     191 
     192Notification 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. 
     193 
     194=== ''Permission denied'' error === 
     195 
     196Typical error message: 
     197{{{ 
     198  ... 
     199  File ".../smtplib.py", line 303, in connect 
     200    raise socket.error, msg 
     201  error: (13, 'Permission denied') 
     202}}} 
     203 
     204This error usually comes from a security settings on the server: many Linux distributions do not let the web server (Apache, ...) to post email message to the local SMTP server. 
     205 
     206Many users get confused when their manual attempts to contact the SMTP server succeed: 
     207{{{ 
     208telnet localhost 25 
     209}}} 
     210The trouble is that a regular user may connect to the SMTP server, but the web server cannot: 
     211{{{ 
     212sudo -u www-data telnet localhost 25 
     213}}} 
     214 
     215In 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 browsing the Trac [trac:MailingList MailingList] archive. 
     216 
     217Relevant ML threads: 
     218 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 
     219 
     220For SELinux in Fedora 10: 
     221{{{ 
     222$ setsebool -P httpd_can_sendmail 1 
     223}}} 
     224=== ''Suspected spam'' error === 
     225 
     226Some SMTP servers may reject the notification email sent by Trac. 
     227 
     228The 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 to change the default encoding to "quoted-printable" using the `mime_encoding` option. 
     229 
     230Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended to stick with the Base64 encoding. 
     231 
     232=== ''501, 5.5.4 Invalid Address'' error === 
     233 
     234On IIS 6.0 you could get a  
     235{{{ 
     236Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address') 
     237}}} 
     238in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it. 
     239 
     240 
     241---- 
     242See also: TracTickets, TracIni, TracGuide