Home

Documentation

Project Support

Changes in Version 1 of TracNotification

Author:
trac
Timestamp:
Wed Aug 23 17:34:43 2006

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v0 v1
      1  = Email Notification of Ticket Changes = 
      2  [[TracGuideToc]] 
      3   
      4  Trac supports basic notification for ticket changes using email.  
      5   
      6  Email 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   
      8  Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini]. 
      9   
      10  == Receiving Notification == 
      11  When reporting a new ticket or adding a comment, enter a validing email address in the ''reporter'', ''editor'' or ''cc'' field. Trac will automatically send you an email when changes are made to the ticket. 
      12   
      13  This is useful to keep up-to-date on an issue or enhancement request that interests you. 
      14   
      15  == Configuring SMTP Notification == 
      16   
      17  === Config Options === 
      18  These are the available options for the ''[notification]'' section in trac.ini. 
      19   * '''smtp_enabled''': Enable notification. 
      20   * '''smtp_server''': SMTP server used for notification messages. 
      21   * '''smtp_from''': Email address to use for ''Sender''-headers in notification emails. 
      22   * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails. 
      23   * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' 
      24   * '''always_notify_reporter''':  Always send notifications to any address in the reporter field. 
      25   
      26  Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
      27   
      28  === Example Configuration === 
      29   
      30  {{{ 
      31  [notification] 
      32  smtp_enabled = true 
      33  smtp_server = mail.example.com 
      34  smtp_from = notifier@example.com 
      35  smtp_replyto = myproj@projects.example.com 
      36  smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com 
      37  }}} 
      38   
      39  == Sample Email == 
      40  {{{ 
      41  #42: testing 
      42  ---------------------------+------------------------------------------------ 
      43         Id:  42             |      Status:  assigned                 
      44  Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004 
      45   Severity:  major          |   Milestone:  0.9                      
      46   Priority:  lowest         |     Version:  0.6                      
      47      Owner:  anonymous      |    Reporter:  jonas@example.com                
      48  ---------------------------+------------------------------------------------ 
      49  Changes: 
      50    * component:  changset view => search system 
      51    * priority:  low => highest 
      52    * owner:  jonas => anonymous 
      53    * cc:  daniel@example.com => 
      54           daniel@example.com, jonas@example.com 
      55    * status:  new => assigned 
      56   
      57  Comment: 
      58  I'm interested too! 
      59   
      60  -- 
      61  Ticket URL: <http://example.com/trac/ticket/42> 
      62  My Project <http://myproj.example.com/> 
      63  }}} 
      64  ---- 
      65  See also: TracTickets, TracIni, TracGuide