Changes from Version 1 of TracNotification

Show
Ignore:
Author:
trac (IP: 127.0.0.1)
Timestamp:
11/14/07 05:44:51 (6 years ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v0 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_user''': (''since 0.9'') User name for authentication SMTP account. 
     22 * '''smtp_password''': (''since 0.9'') Password for authentication SMTP account. 
     23 * '''smtp_from''': Email address to use for ''Sender''-headers in notification emails. 
     24 * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails. 
     25 * '''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. 
     26 * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' 
     27 * '''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  
     28 * '''always_notify_reporter''':  Always send notifications to any address in the reporter field. 
     29 * '''always_notify_owner''': (''since 0.9'') Always send notifications to the address in the owner field. 
     30 * '''always_notify_updater''': (''since 0.10'') Always send a notification to the updater of a ticket. 
     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 
     38Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
     39 
     40=== Example Configuration === 
     41 
     42{{{ 
     43[notification] 
     44smtp_enabled = true 
     45smtp_server = mail.example.com 
     46smtp_from = notifier@example.com 
     47smtp_replyto = myproj@projects.example.com 
     48smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com 
     49}}} 
     50 
     51== Sample Email == 
     52{{{ 
     53#42: testing 
     54---------------------------+------------------------------------------------ 
     55       Id:  42             |      Status:  assigned                 
     56Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004 
     57 Severity:  major          |   Milestone:  0.9                      
     58 Priority:  lowest         |     Version:  0.6                      
     59    Owner:  anonymous      |    Reporter:  jonas@example.com                
     60---------------------------+------------------------------------------------ 
     61Changes: 
     62  * component:  changset view => search system 
     63  * priority:  low => highest 
     64  * owner:  jonas => anonymous 
     65  * cc:  daniel@example.com => 
     66         daniel@example.com, jonas@example.com 
     67  * status:  new => assigned 
     68 
     69Comment: 
     70I'm interested too! 
     71 
     72-- 
     73Ticket URL: <http://example.com/trac/ticket/42> 
     74My Project <http://myproj.example.com/> 
     75}}} 
     76 
     77== Troubleshooting == 
     78 
     79If 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. 
     80 
     81Notification 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. 
     82 
     83=== ''Permission denied'' error === 
     84 
     85Typical error message: 
     86{{{ 
     87  ... 
     88  File ".../smtplib.py", line 303, in connect 
     89    raise socket.error, msg 
     90  error: (13, 'Permission denied') 
     91}}} 
     92 
     93This 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. 
     94 
     95Many users get confused when their manual attempts to contact the SMTP server succeed: 
     96{{{ 
     97telnet localhost 25 
     98}}} 
     99The trouble is that a regular user may connect to the SMTP server, but the web server cannot: 
     100{{{ 
     101sudo -u www-data telnet localhost 25 
     102}}} 
     103 
     104In 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. 
     105 
     106Relevant ML threads: 
     107 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 
     108  
     109=== ''Suspected spam'' error === 
     110 
     111Some SMTP servers may reject the notification email sent by Trac. 
     112 
     113The 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. 
     114 
     115Quoted printable enconding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended to stick with the Base64 encoding. 
     116 
     117---- 
     118See also: TracTickets, TracIni, TracGuide