Edgewall Software

Changes between Initial Version and Version 1 of 0.12/TracNotification


Ignore:
Timestamp:
Mar 17, 2009, 5:29:23 PM (13 years ago)
Author:
Christian Boos
Comment:

copied from wiki:TracNotification@41

Legend:

Unmodified
Added
Removed
Modified
  • 0.12/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
     20 * '''`smtp_enabled`''': Enable email notification.
     21 * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails.
     22 * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails.
     23 * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
     24 * '''`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.
     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 * '''`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
     27 * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
     28 * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false).
     29 * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
     30 * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
     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 * '''`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.
     38 * '''`email_sender`''': (''since 0.12'') Name of the component implementing `IEmailSender`. This component is used by the notification system to send emails. Trac currently provides the following components:
     39   * `SmtpEmailSender`: connects to an SMTP server (default).
     40   * `SendmailEmailSender`: runs a `sendmail`-compatible executable.
     41
     42Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
     43
     44The following options are specific to email delivery through SMTP.
     45 * '''`smtp_server`''': SMTP server used for notification messages.
     46 * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
     47 * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
     48 * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
     49 * '''`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.
     50
     51The following option is specific to email delivery through a `sendmail`-compatible executable.
     52 * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options.
     53
     54=== Example Configuration (SMTP) ===
     55{{{
     56[notification]
     57smtp_enabled = true
     58smtp_server = mail.example.com
     59smtp_from = notifier@example.com
     60smtp_replyto = myproj@projects.example.com
     61smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     62}}}
     63
     64=== Example Configuration (`sendmail`) ===
     65{{{
     66[notification]
     67smtp_enabled = true
     68email_sender = SendmailEmailSender
     69sendmail_path = /usr/sbin/sendmail
     70smtp_from = notifier@example.com
     71smtp_replyto = myproj@projects.example.com
     72smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     73}}}
     74
     75=== Customizing the e-mail subject ===
     76The 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:
     77{{{
     78$prefix #$ticket.id: $summary
     79}}}
     80The following variables are available in the template:
     81
     82 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     83 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     84 * `summary`: The ticket summary, with the old value if the summary was edited.
     85 * `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`.
     86
     87== Sample Email ==
     88{{{
     89#42: testing
     90---------------------------+------------------------------------------------
     91       Id:  42             |      Status:  assigned               
     92Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
     93 Severity:  major          |   Milestone:  0.9                     
     94 Priority:  lowest         |     Version:  0.6                     
     95    Owner:  anonymous      |    Reporter:  jonas@example.com               
     96---------------------------+------------------------------------------------
     97Changes:
     98  * component:  changset view => search system
     99  * priority:  low => highest
     100  * owner:  jonas => anonymous
     101  * cc:  daniel@example.com =>
     102         daniel@example.com, jonas@example.com
     103  * status:  new => assigned
     104
     105Comment:
     106I'm interested too!
     107
     108--
     109Ticket URL: <http://example.com/trac/ticket/42>
     110My Project <http://myproj.example.com/>
     111}}}
     112
     113== Using GMail as the SMTP relay host ==
     114
     115Use the following configuration snippet
     116{{{
     117[notification]
     118smtp_enabled = true
     119use_tls = true
     120mime_encoding = base64
     121smtp_server = smtp.gmail.com
     122smtp_port = 587
     123smtp_user = user
     124smtp_password = password
     125}}}
     126
     127where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     128
     129Alternatively, you can use `smtp_port = 25`.[[br]]
     130You 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.
     131 
     132== Filtering notifications for one's own changes ==
     133In Gmail, use the filter:
     134
     135{{{
     136from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
     137}}}
     138
     139to delete these notifications.
     140
     141In Thunderbird, there is no such solution if you use IMAP
     142(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
     143
     144The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
     145You will however still get an email if you comment a ticket that you own or have reported.
     146
     147You can also add this plugin:
     148http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
     149
     150== Troubleshooting ==
     151
     152If 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.
     153
     154Notification 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.
     155
     156=== ''Permission denied'' error ===
     157
     158Typical error message:
     159{{{
     160  ...
     161  File ".../smtplib.py", line 303, in connect
     162    raise socket.error, msg
     163  error: (13, 'Permission denied')
     164}}}
     165
     166This 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.
     167
     168Many users get confused when their manual attempts to contact the SMTP server succeed:
     169{{{
     170telnet localhost 25
     171}}}
     172The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
     173{{{
     174sudo -u www-data telnet localhost 25
     175}}}
     176
     177In 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.
     178
     179Relevant ML threads:
     180 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     181 
     182=== ''Suspected spam'' error ===
     183
     184Some SMTP servers may reject the notification email sent by Trac.
     185
     186The 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.
     187
     188Quoted 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.
     189
     190----
     191See also: TracTickets, TracIni, TracGuide