Edgewall Software

Version 17 (modified by Emmanuel Blot, 18 years ago) ( diff )

Add doc about the always_notify_updater option

This page documents the 1.4 (latest stable) release. Documentation for other releases can be found here.

Email Notification of Ticket Changes

Trac supports basic notification for ticket changes using email.

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 Trac-tickets mailing list works.

Disabled by default, notification can be activated and configured in trac.ini.

Receiving Notification

When 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.

This is useful to keep up-to-date on an issue or enhancement request that interests you.

Configuring SMTP Notification

Configuration Options

These are the available options for the [notification] section in trac.ini.

  • smtp_enabled: Enable email notification.
  • smtp_server: SMTP server used for notification messages.
  • smtp_user: (requires 0.9) user name for authentication SMTP account.
  • smtp_password: (requires 0.9) password for authentication SMTP account.
  • smtp_from: Email address to use for Sender-headers in notification emails.
  • smtp_replyto: Email address to use for Reply-To-headers in notification emails.
  • smtp_always_cc: List of email addresses to always send notifications to. Typically used to post ticket changes to a dedicated mailing list.
  • smtp_always_bcc: (requires 0.10) List of email addresses to always send notifications to, but keeps addresses not visible from other recipients of the notification email
  • always_notify_reporter: Always send notifications to any address in the reporter field.
  • always_notify_owner: (requires 0.9) Always send notifications to the address in the owner field.
  • always_notify_updater: (requires 0.10) Always send a notification to the updater of a ticket.
  • use_public_cc: (requires 0.10) Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is Bcc: - hidden copy).
  • mime_encoding: (requires 0.10) E-mail notifications are always sent in 7-bit mode. This option allows to select the MIME encoding scheme. Supported values:
    • base64: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    • qp or quoted-printable: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    • none: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
  • smtp_default_domain: (requires 0.10) The specified domain name is appended to short e-mail addresses - i.e. e-mail addresses without a fully qualified domain name.
  • allow_short_addr: (requires 0.10) Short e-mail addresses are accepted. When this option is enabled, it's up to the SMTP server to resolve the e-mail address. Do not use this option with a public SMTP server.

Either smtp_from or smtp_replyto (or both) must be set, otherwise Trac refuses to send notification mails.

Example Configuration

[notification]
smtp_enabled = true
smtp_server = mail.example.com
smtp_from = notifier@example.com
smtp_replyto = myproj@projects.example.com
smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com

Sample Email

#42: testing
---------------------------+------------------------------------------------
       Id:  42             |      Status:  assigned                
Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
 Severity:  major          |   Milestone:  0.9                     
 Priority:  lowest         |     Version:  0.6                     
    Owner:  anonymous      |    Reporter:  jonas@example.com               
---------------------------+------------------------------------------------
Changes:
  * component:  changset view => search system
  * priority:  low => highest
  * owner:  jonas => anonymous
  * cc:  daniel@example.com =>
         daniel@example.com, jonas@example.com
  * status:  new => assigned

Comment:
I'm interested too!

--
Ticket URL: <http://example.com/trac/ticket/42>
My Project <http://myproj.example.com/>

See also: TracTickets, TracIni, TracGuide

Note: See TracWiki for help on using the wiki.