Changes between Initial Version and Version 1 of TracNotification


Ignore:
Timestamp:
Apr 30, 2009, 11:21:47 AM (10 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 * '''ticket_subject_template''': (''since 0.11'') A [http://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet used to get the notification subject.
     42
     43Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
     44
     45=== Example Configuration ===
     46
     47{{{
     48[notification]
     49smtp_enabled = true
     50smtp_server = mail.example.com
     51smtp_from = notifier@example.com
     52smtp_replyto = myproj@projects.example.com
     53smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     54}}}
     55
     56=== Customizing the e-mail subject ===
     57The e-mail subject can be customized with the `ticket_subject_template` option, which contains a [http://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet. The default value is:
     58{{{
     59$prefix #$ticket.id: $summary
     60}}}
     61The following variables are available in the template:
     62
     63 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     64 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     65 * `summary`: The ticket summary, with the old value if the summary was edited.
     66 * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, e.g. `$ticket.milestone`.
     67
     68== Sample Email ==
     69{{{
     70#42: testing
     71---------------------------+------------------------------------------------
     72       Id:  42             |      Status:  assigned               
     73Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
     74 Severity:  major          |   Milestone:  0.9                     
     75 Priority:  lowest         |     Version:  0.6                     
     76    Owner:  anonymous      |    Reporter:  jonas@example.com               
     77---------------------------+------------------------------------------------
     78Changes:
     79  * component:  changset view => search system
     80  * priority:  low => highest
     81  * owner:  jonas => anonymous
     82  * cc:  daniel@example.com =>
     83         daniel@example.com, jonas@example.com
     84  * status:  new => assigned
     85
     86Comment:
     87I'm interested too!
     88
     89--
     90Ticket URL: <http://example.com/trac/ticket/42>
     91My Project <http://myproj.example.com/>
     92}}}
     93
     94== Using GMail as the SMTP relay host ==
     95
     96Use the following configuration snippet
     97{{{
     98[notification]
     99smtp_enabled = true
     100use_tls = true
     101mime_encoding = base64
     102smtp_server = smtp.gmail.com
     103smtp_port = 587
     104smtp_user = user
     105smtp_password = password
     106}}}
     107
     108where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     109
     110Alternatively, you can use `smtp_port = 25`.[[br]]
     111You 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.
     112 
     113== Filtering notifications for one's own changes ==
     114In Gmail, use the filter:
     115
     116{{{
     117from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
     118}}}
     119
     120to delete these notifications.
     121
     122In Thunderbird, there is no such solution if you use IMAP
     123(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
     124
     125The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
     126You will however still get an email if you comment a ticket that you own or have reported.
     127
     128You can also add this plugin:
     129http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
     130
     131== Troubleshooting ==
     132
     133If 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.
     134
     135Notification 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.
     136
     137=== ''Permission denied'' error ===
     138
     139Typical error message:
     140{{{
     141  ...
     142  File ".../smtplib.py", line 303, in connect
     143    raise socket.error, msg
     144  error: (13, 'Permission denied')
     145}}}
     146
     147This 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.
     148
     149Many users get confused when their manual attempts to contact the SMTP server succeed:
     150{{{
     151telnet localhost 25
     152}}}
     153The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
     154{{{
     155sudo -u www-data telnet localhost 25
     156}}}
     157
     158In such a case, you need to configure your server so that the web server is authorized 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 [trac:MailingList MailingList] archive.
     159
     160Relevant ML threads:
     161 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     162 
     163=== ''Suspected spam'' error ===
     164
     165Some SMTP servers may reject the notification email sent by Trac.
     166
     167The 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.
     168
     169Quoted 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.
     170
     171----
     172See also: TracTickets, TracIni, TracGuide