Changes between Initial Version and Version 1 of TracNotification

Show
Ignore:
Timestamp:
04/30/10 16:55:49 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v1 v1  
     1= Email Notification of Ticket Changes = 
     2[[TracGuideToc]] 
     3 
     4Trac supports notification about ticket changes via email.  
     5 
     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]. 
     9 
     10== Receiving Notification Mails == 
     11When reporting a new ticket or adding a comment, enter a valid email address 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). 
     12 
     13This is useful to keep up-to-date on an issue or enhancement request that interests you. 
     14 
     15== Configuring SMTP Notification == 
     16 
     17=== Configuration Options === 
     18These are the available options for the `[notification]` section in trac.ini. 
     19 
     20 * '''`smtp_enabled`''': Enable email notification. 
     21 * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails. 
     22 * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails. 
     23 * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails. 
     24 * '''`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. 
     25 * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' 
     26 * '''`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  
     27 * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default. 
     28 * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false). 
     29 * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false). 
     30 * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true). 
     31 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). 
     32 * '''`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.  
     33 * '''`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: 
     34   * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. 
     35   * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64) 
     36   * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.  
     37 * '''`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. 
     38 
     39Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
     40 
     41The following options are specific to email delivery through SMTP. 
     42 * '''`smtp_server`''': SMTP server used for notification messages. 
     43 * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server. 
     44 * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account. 
     45 * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account. 
     46 * '''`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. 
     47 
     48 
     49=== Example Configuration (SMTP) === 
     50{{{ 
     51[notification] 
     52smtp_enabled = true 
     53smtp_server = mail.example.com 
     54smtp_from = notifier@example.com 
     55smtp_replyto = myproj@projects.example.com 
     56smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com 
     57}}} 
     58 
     59 
     60=== Customizing the e-mail subject === 
     61The 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: 
     62{{{ 
     63$prefix #$ticket.id: $summary 
     64}}} 
     65The following variables are available in the template: 
     66 
     67 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]). 
     68 * `prefix`: The prefix defined in `smtp_subject_prefix`. 
     69 * `summary`: The ticket summary, with the old value if the summary was edited. 
     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, e.g. `$ticket.milestone`. 
     71 
     72== Sample Email == 
     73{{{ 
     74#42: testing 
     75---------------------------+------------------------------------------------ 
     76       Id:  42             |      Status:  assigned                 
     77Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004 
     78 Severity:  major          |   Milestone:  0.9                      
     79 Priority:  lowest         |     Version:  0.6                      
     80    Owner:  anonymous      |    Reporter:  jonas@example.com                
     81---------------------------+------------------------------------------------ 
     82Changes: 
     83  * component:  changset view => search system 
     84  * priority:  low => highest 
     85  * owner:  jonas => anonymous 
     86  * cc:  daniel@example.com => 
     87         daniel@example.com, jonas@example.com 
     88  * status:  new => assigned 
     89 
     90Comment: 
     91I'm interested too! 
     92 
     93-- 
     94Ticket URL: <http://example.com/trac/ticket/42> 
     95My Project <http://myproj.example.com/> 
     96}}} 
     97 
     98== Using GMail as the SMTP relay host == 
     99 
     100Use the following configuration snippet 
     101{{{ 
     102[notification] 
     103smtp_enabled = true 
     104use_tls = true 
     105mime_encoding = base64 
     106smtp_server = smtp.gmail.com 
     107smtp_port = 587 
     108smtp_user = user 
     109smtp_password = password 
     110}}} 
     111 
     112where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com] 
     113 
     114Alternatively, you can use `smtp_port = 25`.[[br]] 
     115You 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. 
     116  
     117== Filtering notifications for one's own changes == 
     118In Gmail, use the filter: 
     119 
     120{{{ 
     121from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)") 
     122}}} 
     123 
     124to delete these notifications. 
     125 
     126In Thunderbird, there is no such solution if you use IMAP 
     127(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body). 
     128 
     129The best you can do is to set "always_notify_updater" in conf/trac.ini to false. 
     130You will however still get an email if you comment a ticket that you own or have reported. 
     131 
     132You can also add this plugin: 
     133http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin 
     134 
     135== Troubleshooting == 
     136 
     137If 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. 
     138 
     139Notification 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. 
     140 
     141=== ''Permission denied'' error === 
     142 
     143Typical error message: 
     144{{{ 
     145  ... 
     146  File ".../smtplib.py", line 303, in connect 
     147    raise socket.error, msg 
     148  error: (13, 'Permission denied') 
     149}}} 
     150 
     151This 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. 
     152 
     153Many users get confused when their manual attempts to contact the SMTP server succeed: 
     154{{{ 
     155telnet localhost 25 
     156}}} 
     157The trouble is that a regular user may connect to the SMTP server, but the web server cannot: 
     158{{{ 
     159sudo -u www-data telnet localhost 25 
     160}}} 
     161 
     162In 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. 
     163 
     164Relevant ML threads: 
     165 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 
     166  
     167=== ''Suspected spam'' error === 
     168 
     169Some SMTP servers may reject the notification email sent by Trac. 
     170 
     171The 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. 
     172 
     173Quoted 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. 
     174 
     175---- 
     176See also: TracTickets, TracIni, TracGuide