annotate examples/trac/wiki-default/TracNotification @ 60:2cb5b54d87ff trunk

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