Changes between Initial Version and Version 1 of TracNotification


Ignore:
Timestamp:
06/09/09 17:06:31 (5 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 * '''smtp_enabled''': Enable email notification. 
     20 * '''smtp_server''': SMTP server used for notification messages. 
     21 * '''smtp_port''': (''since 0.9'') Port used to contact the SMTP server. 
     22 * '''smtp_user''': (''since 0.9'') User name for authentication SMTP account. 
     23 * '''smtp_password''': (''since 0.9'') Password for authentication SMTP account. 
     24 * '''smtp_from''': Email address to use for ''Sender''-headers in notification emails. 
     25 * '''smtp_from_name''': Sender name to use for ''Sender''-headers in notification emails. 
     26 * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails. 
     27 * '''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. 
     28 * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' 
     29 * '''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  
     30 * '''smtp_subject_prefix''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default. 
     31 * '''always_notify_reporter''':  Always send notifications to any address in the reporter field (default: false). 
     32 * '''always_notify_owner''': (''since 0.9'') Always send notifications to the address in the owner field (default: false). 
     33 * '''always_notify_updater''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true). 
     34 * '''use_public_cc''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). 
     35 * '''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.  
     36 * '''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. 
     37 * '''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: 
     38   * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. 
     39   * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64) 
     40   * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.  
     41 
     42Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
     43 
     44=== Example Configuration === 
     45 
     46{{{ 
     47[notification] 
     48smtp_enabled = true 
     49smtp_server = mail.example.com 
     50smtp_from = notifier@example.com 
     51smtp_replyto = myproj@projects.example.com 
     52smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com 
     53}}} 
     54 
     55== Sample Email == 
     56{{{ 
     57#42: testing 
     58---------------------------+------------------------------------------------ 
     59       Id:  42             |      Status:  assigned                 
     60Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004 
     61 Severity:  major          |   Milestone:  0.9                      
     62 Priority:  lowest         |     Version:  0.6                      
     63    Owner:  anonymous      |    Reporter:  jonas@example.com                
     64---------------------------+------------------------------------------------ 
     65Changes: 
     66  * component:  changset view => search system 
     67  * priority:  low => highest 
     68  * owner:  jonas => anonymous 
     69  * cc:  daniel@example.com => 
     70         daniel@example.com, jonas@example.com 
     71  * status:  new => assigned 
     72 
     73Comment: 
     74I'm interested too! 
     75 
     76-- 
     77Ticket URL: <http://example.com/trac/ticket/42> 
     78My Project <http://myproj.example.com/> 
     79}}} 
     80 
     81== Using GMail as the SMTP relay host == 
     82 
     83Use the following configuration snippet 
     84{{{ 
     85[notification] 
     86smtp_enabled = true 
     87use_tls = true 
     88mime_encoding = base64 
     89smtp_server = smtp.gmail.com 
     90smtp_port = 587 
     91smtp_user = user 
     92smtp_password = password 
     93}}} 
     94 
     95where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com] 
     96 
     97Alternatively, you can use `smtp_port = 25`.[[br]] 
     98You 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. 
     99  
     100== Filtering notifications for one's own changes == 
     101In Gmail, use the filter: 
     102 
     103{{{ 
     104from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)") 
     105}}} 
     106 
     107to delete these notifications. 
     108 
     109== Troubleshooting == 
     110 
     111If 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. 
     112 
     113Notification 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. 
     114 
     115=== ''Permission denied'' error === 
     116 
     117Typical error message: 
     118{{{ 
     119  ... 
     120  File ".../smtplib.py", line 303, in connect 
     121    raise socket.error, msg 
     122  error: (13, 'Permission denied') 
     123}}} 
     124 
     125This 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. 
     126 
     127Many users get confused when their manual attempts to contact the SMTP server succeed: 
     128{{{ 
     129telnet localhost 25 
     130}}} 
     131The trouble is that a regular user may connect to the SMTP server, but the web server cannot: 
     132{{{ 
     133sudo -u www-data telnet localhost 25 
     134}}} 
     135 
     136In such a case, you need to configure your server so that the web server is authorize 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 MailingList archive. 
     137 
     138Relevant ML threads: 
     139 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 
     140  
     141=== ''Suspected spam'' error === 
     142 
     143Some SMTP servers may reject the notification email sent by Trac. 
     144 
     145The 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. 
     146 
     147Quoted 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. 
     148 
     149---- 
     150See also: TracTickets, TracIni, TracGuide