source: wiki/pages/TracNotification @ 40542

Last change on this file since 40542 was 40542, checked in by obi, 2 years ago

reset wiki files

File size: 11.5 KB
Line 
1= Email Notification of Ticket Changes
2[[TracGuideToc]]
3
4Trac supports notification of 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 or your Trac username 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
13=== How to use your username to receive notification mails
14
15To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page.
16
17Alternatively, a default domain name ('''`smtp_default_domain`''') can be set in the TracIni file, see [#ConfigurationOptions Configuration Options] below. In this case, the default domain will be appended to the username, which can be useful for an "Intranet" kind of installation.
18
19When using apache and mod_kerb for authentication against Kerberos / Active Directory, usernames take the form ('''`username@EXAMPLE.LOCAL`'''). To avoid this being interpreted as an email address, add the Kerberos domain to  ('''`ignore_domains`''').
20
21=== Ticket attachment notifications
22
23Since 1.0.3 Trac will send notifications when a ticket attachment is added or deleted. Usually attachment notifications will be enabled in an environment by default. To disable the attachment notifications for an environment the `TicketAttachmentNotifier` component must be disabled:
24{{{#!ini
25[components]
26trac.ticket.notification.TicketAttachmentNotifier = disabled
27}}}
28
29== Configuring SMTP Notification
30
31'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
32
33=== Configuration Options
34These are the available options for the `[notification]` section in trac.ini:
35
36[[TracIni(notification)]]
37
38=== Example Configuration (SMTP)
39{{{#!ini
40[notification]
41smtp_enabled = true
42smtp_server = mail.example.com
43smtp_from = notifier@example.com
44smtp_replyto = myproj@projects.example.com
45smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
46}}}
47
48=== Example Configuration (`sendmail`)
49{{{#!ini
50[notification]
51smtp_enabled = true
52email_sender = SendmailEmailSender
53sendmail_path = /usr/sbin/sendmail
54smtp_from = notifier@example.com
55smtp_replyto = myproj@projects.example.com
56smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
57}}}
58
59=== Subscriber Configuration
60The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
61
62[[TracIni(notification-subscriber)]]
63
64Each user can override these defaults in his ''Notifications'' preferences.
65
66For example to unsubscribe from notifications for one's own changes and comments, the rule "Never notify: I update a ticket" should be added above other subscription rules.
67
68=== Customizing the e-mail subject
69The 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:
70{{{#!genshi
71$prefix #$ticket.id: $summary
72}}}
73The following variables are available in the template:
74
75 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
76 * `prefix`: The prefix defined in `smtp_subject_prefix`.
77 * `summary`: The ticket summary, with the old value if the summary was edited.
78 * `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, eg `$ticket.milestone`.
79
80=== Customizing the e-mail content
81
82The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. You can add your own version of this template by adding a `ticket_notify_email.txt` to the templates directory of your environment. The default looks like this:
83
84{{{#!genshi
85$ticket_body_hdr
86$ticket_props
87{% choose ticket.new %}\
88{%   when True %}\
89$ticket.description
90{%   end %}\
91{%   otherwise %}\
92{%     if changes_body %}\
93${_('Changes (by %(author)s):', author=change.author)}
94
95$changes_body
96{%     end %}\
97{%     if changes_descr %}\
98{%       if not changes_body and not change.comment and change.author %}\
99${_('Description changed by %(author)s:', author=change.author)}
100{%       end %}\
101$changes_descr
102--
103{%     end %}\
104{%     if change.comment %}\
105
106${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
107
108$change.comment
109{%     end %}\
110{%   end %}\
111{% end %}\
112
113--
114${_('Ticket URL: <%(link)s>', link=ticket.link)}
115$project.name <${project.url or abs_href()}>
116$project.descr
117}}}
118
119== Sample Email
120{{{
121#42: testing
122---------------------------+------------------------------------------------
123       Id:  42             |      Status:  assigned               
124Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
125 Severity:  major          |   Milestone:  0.9                     
126 Priority:  lowest         |     Version:  0.6                     
127    Owner:  anonymous      |    Reporter:  jonas@example.com               
128---------------------------+------------------------------------------------
129Changes:
130  * component:  changeset view => search system
131  * priority:  low => highest
132  * owner:  jonas => anonymous
133  * cc:  daniel@example.com =>
134         daniel@example.com, jonas@example.com
135  * status:  new => assigned
136
137Comment:
138I'm interested too!
139
140--
141Ticket URL: <http://example.com/trac/ticket/42>
142My Project <http://myproj.example.com/>
143}}}
144
145== Customizing e-mail content for MS Outlook
146
147MS Outlook normally presents plain text e-mails with a variable-width font, and as a result the ticket properties table will most certainly look like a mess in MS Outlook. This can be fixed with some customization of the [#Customizingthee-mailcontent e-mail template].
148
149Replace the following second row in the template:
150{{{
151$ticket_props
152}}}
153
154with this (requires Python 2.6 or later):
155{{{
156--------------------------------------------------------------------------
157{% with
158   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
159         [c.strip() for c in
160          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
161   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
162          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
163${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
164{% end %}\
165--------------------------------------------------------------------------
166}}}
167
168The table of ticket properties is replaced with a list of a selection of the properties. A tab character separates the name and value in such a way that most people should find this more pleasing than the default table when using MS Outlook.
169{{{#!div style="margin: 1em 1.75em; border:1px dotted"
170{{{#!html
171#42: testing<br />
172--------------------------------------------------------------------------<br />
173<table cellpadding=0>
174<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
175<tr><td>Owner:</td><td>anonymous</td></tr>
176<tr><td>Type:</td><td>defect</td></tr>
177<tr><td>Status:</td><td>assigned</td></tr>
178<tr><td>Priority:</td><td>lowest</td></tr>
179<tr><td>Milestone:</td><td>0.9</td></tr>
180<tr><td>Component:</td><td>report system</td></tr>
181<tr><td>Severity:</td><td>major</td></tr>
182<tr><td>Resolution:</td><td> </td></tr>
183<tr><td>Keywords:</td><td> </td></tr>
184</table>
185--------------------------------------------------------------------------<br />
186Changes:<br />
187<br />
188&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
189&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
190&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
191&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
193&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
194<br />
195Comment:<br />
196I'm interested too!<br />
197<br />
198--<br />
199Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
200My Project &lt;http://myproj.example.com/&gt;<br />
201}}}
202}}}
203
204**Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which are to be part of the mail, then they have to be added to `sel`. Example:
205{{{
206   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
207}}}
208
209However, the solution is still a workaround to an automatically HTML-formatted e-mail.
210
211== Using GMail as the SMTP relay host
212
213Use the following configuration snippet:
214{{{#!ini
215[notification]
216smtp_enabled = true
217use_tls = true
218mime_encoding = base64
219smtp_server = smtp.gmail.com
220smtp_port = 587
221smtp_user = user
222smtp_password = password
223}}}
224
225where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
226
227Alternatively, you can use `smtp_port = 25`.[[br]]
228You should not use `smtp_port = 465`. Doing so may deadlock your ticket submission. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [trac:comment:2:ticket:7107 #7107] for details.
229
230== Troubleshooting
231
232If 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.
233
234Notification errors are not reported through the web interface, so the user who submits 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.
235
236=== ''Permission denied'' error
237
238Typical error message:
239{{{#!sh
240  ...
241  File ".../smtplib.py", line 303, in connect
242    raise socket.error, msg
243  error: (13, 'Permission denied')
244}}}
245
246This error usually comes from a security settings on the server: many Linux distributions do not allow the web server (Apache, ...) to post email messages to the local SMTP server.
247
248Many users get confused when their manual attempts to contact the SMTP server succeed:
249{{{#!sh
250telnet localhost 25
251}}}
252This is because a regular user may connect to the SMTP server, but the web server cannot:
253{{{#!sh
254sudo -u www-data telnet localhost 25
255}}}
256
257In 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 in the Trac [trac:MailingList MailingList] archive.
258
259Relevant ML threads:
260 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
261
262For SELinux in Fedora 10:
263{{{#!sh
264$ setsebool -P httpd_can_sendmail 1
265}}}
266
267=== ''Suspected spam'' error
268
269Some SMTP servers may reject the notification email sent by Trac.
270
271The 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, change the default encoding to "quoted-printable" using the `mime_encoding` option.
272
273Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
274
275----
276See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]
Note: See TracBrowser for help on using the repository browser.