TracNotification (diff) - Xwrits - Trac

Changes from Version 1 of TracNotification

Show
Ignore:
Author:
trac (IP: 127.0.0.1)
Timestamp:
10/30/06 19:35:42 (9 months ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    vv1 
     1= Email Notification of Ticket Changes = 
     2[[TracGuideToc]] 
     3 
     4Trac supports basic notification for ticket changes using 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 ticket changes to a dedicated mailing list. '''Note:''' As an example, this is how the [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] mailing list works. 
     7 
     8Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini]. 
     9 
     10== Receiving Notification == 
     11When reporting a new ticket or adding a comment, enter a valid email address in the ''reporter'', ''editor'' or ''cc'' field. Trac will automatically send you an email when changes are made to the ticket. 
     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''': (''requires [milestone:0.9 0.9]'') user name for authentication SMTP account. 
     22 * '''smtp_password''': (''requires [milestone:0.9 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_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' 
     26 * '''always_notify_reporter''':  Always send notifications to any address in the reporter field. 
     27 * '''always_notify_owner''': (''requires [milestone:0.9 0.9]'') Always send notifications to the address in the owner field. 
     28 
     29Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
     30 
     31=== Example Configuration === 
     32 
     33{{{ 
     34[notification] 
     35smtp_enabled = true 
     36smtp_server = mail.example.com 
     37smtp_from = notifier@example.com 
     38smtp_replyto = myproj@projects.example.com 
     39smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com 
     40}}} 
     41 
     42== Sample Email == 
     43{{{ 
     44#42: testing 
     45---------------------------+------------------------------------------------ 
     46       Id:  42             |      Status:  assigned                 
     47Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004 
     48 Severity:  major          |   Milestone:  0.9                      
     49 Priority:  lowest         |     Version:  0.6                      
     50    Owner:  anonymous      |    Reporter:  jonas@example.com                
     51---------------------------+------------------------------------------------ 
     52Changes: 
     53  * component:  changset view => search system 
     54  * priority:  low => highest 
     55  * owner:  jonas => anonymous 
     56  * cc:  daniel@example.com => 
     57         daniel@example.com, jonas@example.com 
     58  * status:  new => assigned 
     59 
     60Comment: 
     61I'm interested too! 
     62 
     63-- 
     64Ticket URL: <http://example.com/trac/ticket/42> 
     65My Project <http://myproj.example.com/> 
     66}}} 
     67---- 
     68See also: TracTickets, TracIni, TracGuide