| 4 | | Trac supports notification about ticket changes via email. |
| 5 | | |
| 6 | | Email 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 | | |
| 8 | | Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini]. |
| 9 | | |
| 10 | | == Receiving Notification Mails == |
| 11 | | 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 (depending on how notification is configured). |
| 12 | | |
| 13 | | This 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 === |
| 18 | | These 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_replyto''': Email address to use for ''Reply-To''-headers in notification emails. |
| 26 | | * '''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. |
| 27 | | * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' |
| 28 | | * '''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 |
| 29 | | * '''smtp_subject_prefix''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default. |
| 30 | | * '''always_notify_reporter''': Always send notifications to any address in the reporter field (default: false). |
| 31 | | * '''always_notify_owner''': (''since 0.9'') Always send notifications to the address in the owner field (default: false). |
| 32 | | * '''always_notify_updater''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true). |
| 33 | | * '''use_public_cc''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). |
| 34 | | * '''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. |
| 35 | | * '''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. |
| 36 | | * '''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: |
| 37 | | * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. |
| 38 | | * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64) |
| 39 | | * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered. |
| 40 | | |
| 41 | | Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. |
| 42 | | |
| 43 | | === Example Configuration === |
| 44 | | |
| 45 | | {{{ |
| | 4 | Trac supports notification of ticket changes via email. |
| | 5 | |
| | 6 | Email notification is useful to keep users up-to-date on tickets of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list. |
| | 7 | |
| | 8 | Disabled by default, notification can be activated and configured in [TracIni trac.ini]. |
| | 9 | |
| | 10 | == Receiving Notification Mails |
| | 11 | When 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 may send you an email when changes are made to the ticket, depending on how your notification preferences are configured. |
| | 12 | |
| | 13 | Permission groups can also be entered in the CC field, |
| | 14 | to notify all members of the group. |
| | 15 | |
| | 16 | === How to use your username to receive notification mails |
| | 17 | |
| | 18 | To 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 your [/prefs preferences]. |
| | 19 | |
| | 20 | Alternatively, 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. |
| | 21 | |
| | 22 | When 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`'''). |
| | 23 | |
| | 24 | === Ticket attachment notifications |
| | 25 | |
| | 26 | Since 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: |
| | 27 | {{{#!ini |
| | 28 | [components] |
| | 29 | trac.ticket.notification.TicketAttachmentNotifier = disabled |
| | 30 | }}} |
| | 31 | |
| | 32 | == Configuring SMTP Notification |
| | 33 | |
| | 34 | '''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated. |
| | 35 | |
| | 36 | === Configuration Options |
| | 37 | These are the available options for the `[notification]` section in trac.ini: |
| | 38 | |
| | 39 | [[TracIni(section=notification)]] |
| | 40 | |
| | 41 | === Example Configuration (SMTP) |
| | 42 | {{{#!ini |
| 54 | | == Sample Email == |
| | 51 | === Example Configuration (`sendmail`) |
| | 52 | {{{#!ini |
| | 53 | [notification] |
| | 54 | smtp_enabled = true |
| | 55 | email_sender = SendmailEmailSender |
| | 56 | sendmail_path = /usr/sbin/sendmail |
| | 57 | smtp_from = notifier@example.com |
| | 58 | smtp_replyto = myproj@projects.example.com |
| | 59 | smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com |
| | 60 | }}} |
| | 61 | |
| | 62 | === Subscriber Configuration |
| | 63 | The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section. |
| | 64 | |
| | 65 | [[TracIni(section=notification-subscriber)]] |
| | 66 | |
| | 67 | Each user can override these defaults in their ''Notifications'' preferences. |
| | 68 | |
| | 69 | For 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. |
| | 70 | |
| | 71 | The subscription rule name on the left side of the `=` can be anything, it has no meaning outside this configuration file. The subscriber name on the right side of the `=` must be one of the subscribers listed in the above table. |
| | 72 | |
| | 73 | The following attributes of default subscriptions can be configured: |
| | 74 | * `.distributor` (Default: `email`) |
| | 75 | * Other values require plugins. For example `on-site` requires [https://trac-hacks.org/wiki/OnSiteNotificationsPlugin OnSiteNotificationsPlugin]. |
| | 76 | * `.priority` (Default: `100`) |
| | 77 | * Smaller values override larger values. |
| | 78 | * If you use `0`, then users will not be able to override this rule. |
| | 79 | * `.adverb` (Default: `always`) |
| | 80 | * `never` can be used to silence other subscription rules with higher values. |
| | 81 | * `.format` (Default: `text/plain`) |
| | 82 | * Other values require plugins. For example `text/html` requires [https://trac-hacks.org/wiki/TracHtmlNotificationPlugin TracHtmlNotificationPlugin]. |
| | 83 | |
| | 84 | === Example Configuration (default subscriptions) |
| | 85 | |
| | 86 | This example implements the often desired |
| | 87 | //Never Notify Updater// behavior by setting |
| | 88 | the priority of that rule to the highest value, |
| | 89 | thereby taking precedence over other rules. |
| | 90 | |
| | 91 | {{{#!ini |
| | 92 | [notification-subscriber] |
| | 93 | always_notify_owner = TicketOwnerSubscriber |
| | 94 | always_notify_owner.distributor = email |
| | 95 | always_notify_owner.priority = 100 |
| | 96 | always_notify_owner.adverb = always |
| | 97 | always_notify_owner.format = text/plain |
| | 98 | |
| | 99 | always_notify_previous_updater = TicketPreviousUpdatersSubscriber |
| | 100 | |
| | 101 | never_notify_updater = TicketUpdaterSubscriber |
| | 102 | never_notify_updater.adverb = never |
| | 103 | never_notify_updater.priority = 0 |
| | 104 | |
| | 105 | notify_cc_html = CarbonCopySubscriber |
| | 106 | notify_cc_html.format = text/html |
| | 107 | }}} |
| | 108 | |
| | 109 | === Customizing the email subject |
| | 110 | The email subject can be customized with the `ticket_subject_template` option, which contains a [https://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet. The default value is: |
| | 111 | {{{#!genshi |
| | 112 | ${prefix} #${ticket.id}: ${summary} |
| | 113 | }}} |
| | 114 | The following variables are available in the template: |
| | 115 | |
| | 116 | * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]). |
| | 117 | * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]). |
| | 118 | * `prefix`: The prefix defined in `smtp_subject_prefix`. |
| | 119 | * `summary`: The ticket summary, with the old value if the summary was edited. |
| | 120 | * `ticket`: The ticket model object (see [trac:source:/branches/1.4-stable/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, eg `${ticket.milestone}`. |
| | 121 | |
| | 122 | === Customizing the email content #CustomizingContent |
| | 123 | |
| | 124 | The notification email 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 is: |
| | 125 | |
| | 126 | {{{#!jinja |
| | 127 | ${ticket_body_hdr} |
| | 128 | ${ticket_props} |
| | 129 | # if ticket.new: |
| | 130 | ${ticket.description} |
| | 131 | # else: |
| | 132 | # if changes_body: |
| | 133 | ${_('Changes (by %(author)s):', author=change.author)} |
| | 134 | |
| | 135 | ${changes_body} |
| | 136 | # endif |
| | 137 | # if changes_descr: |
| | 138 | # if not changes_body and not change.comment and change.author: |
| | 139 | ${_('Description changed by %(author)s:', author=change.author)} |
| | 140 | # endif |
| | 141 | ${changes_descr} |
| | 142 | -- |
| | 143 | # endif |
| | 144 | # if change.comment: |
| | 145 | |
| | 146 | ${_('Comment:') if changes_body else |
| | 147 | _('Comment (by %(author)s):', author=change.author)} |
| | 148 | |
| | 149 | ${change.comment} |
| | 150 | # endif |
| | 151 | # endif |
| | 152 | ${'-- '} |
| | 153 | ${_('Ticket URL: <%(link)s>', link=ticket.link)} |
| | 154 | ${project.name} <${project.url or abs_href()}> |
| | 155 | ${project.descr} |
| | 156 | }}} |
| | 157 | |
| | 158 | See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes. |
| | 159 | |
| | 160 | == Sample Email |
| 80 | | == Filtering notifications for one's own changes == |
| 81 | | In Gmail, use the filter: |
| 82 | | |
| 83 | | {{{ |
| 84 | | from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)") |
| 85 | | }}} |
| 86 | | |
| 87 | | to delete these notifications. |
| 88 | | |
| 89 | | == Troubleshooting == |
| 90 | | |
| 91 | | If 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. |
| 92 | | |
| 93 | | Notification 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. |
| 94 | | |
| 95 | | === ''Permission denied'' error === |
| | 186 | == Using GMail as the SMTP relay host |
| | 187 | |
| | 188 | Use the following configuration snippet: |
| | 189 | {{{#!ini |
| | 190 | [notification] |
| | 191 | smtp_enabled = true |
| | 192 | use_tls = true |
| | 193 | mime_encoding = base64 |
| | 194 | smtp_server = smtp.gmail.com |
| | 195 | smtp_port = 587 |
| | 196 | smtp_user = user |
| | 197 | smtp_password = password |
| | 198 | }}} |
| | 199 | |
| | 200 | where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com]. |
| | 201 | |
| | 202 | Alternatively, you can use `smtp_port = 25`.[[br]] |
| | 203 | You 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. |
| | 204 | |
| | 205 | == Troubleshooting |
| | 206 | |
| | 207 | If notifications are not working, inspect the [TracLogging log] for error messages. |
| | 208 | |
| | 209 | Notification errors are not always reported through the web interface, so the user who submits a change or creates a ticket may not get notified about a notification failure. The Trac administrator needs to look at the log to find the error message and traceback. |
| | 210 | |
| | 211 | === Permission denied error |
