Changes between Version 6 and Version 7 of TracNotification


Ignore:
Timestamp:
Jan 12, 2016, 11:21:52 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v6 v7  
    1 = Email Notification of Ticket Changes
     1= Email Notification of Ticket Changes =
    22[[TracGuideToc]]
    33
     
    88Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
    99
    10 == Receiving Notification Mails
    11 
    12 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 will automatically send you an email when changes are made to the ticket, depending on how notification is configured.
    13 
    14 === How to use your username to receive notification mails
    15 
    16 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 the ''Preferences'' page.
    17 
    18 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.
     10== Receiving Notification Mails ==
     11When reporting a new ticket or adding a comment, enter a valid email address or your 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
     13This is useful to keep up-to-date on an issue or enhancement request that interests you.
     14
     15=== How to use your username to receive notification mails ===
     16
     17To receive notification mails, you can either enter a full email address or your username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page.
     18
     19Alternatively, 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.
    1920
    2021When 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`''').
    2122
    22 === Ticket attachment notifications
    23 
    24 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:
    25 {{{#!ini
    26 [components]
    27 trac.ticket.notification.TicketAttachmentNotifier = disabled
    28 }}}
    29 
    30 == Configuring SMTP Notification
     23== Configuring SMTP Notification ==
    3124
    3225'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    3326
    34 === Configuration Options
    35 
    36 These are the available options for the `[notification]` section in `trac.ini`:
    37 
    38 [[TracIni(notification)]]
    39 
    40 === Example Configuration (SMTP)
    41 
    42 {{{#!ini
     27=== Configuration Options ===
     28These are the available options for the `[notification]` section in trac.ini.
     29
     30 * '''`smtp_enabled`''': Enable email notification.
     31 * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails.
     32 * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails.
     33 * '''`smtp_from_author`''': (''since 1.0'') Use the author of a change (the reporter of a new ticket, or the author of a comment) as the `From:` header value in notification e-mails (default: false). If the author hasn't set an e-mail address, `smtp_from` and `smtp_from_name` are used instead.
     34 * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
     35 * '''`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.
     36 * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
     37 * '''`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
     38 * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
     39 * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false).
     40 * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
     41 * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
     42 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
     43 * '''`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.
     44 * '''`ignore_domains`''': Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).
     45 * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values:
     46   * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.
     47   * `base64`: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
     48   * `qp` or `quoted-printable`: best for european languages (more compact than base64) if 8bit encoding cannot be used.
     49 * '''`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.
     50 * '''`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:
     51   * `SmtpEmailSender`: connects to an SMTP server (default).
     52   * `SendmailEmailSender`: runs a `sendmail`-compatible executable.
     53
     54Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
     55
     56The following options are specific to email delivery through SMTP.
     57 * '''`smtp_server`''': SMTP server used for notification messages.
     58 * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
     59 * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
     60 * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
     61 * '''`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.
     62
     63The following option is specific to email delivery through a `sendmail`-compatible executable.
     64 * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options.
     65
     66=== Example Configuration (SMTP) ===
     67{{{
    4368[notification]
    4469smtp_enabled = true
     
    4974}}}
    5075
    51 === Example Configuration (`sendmail`)
    52 
    53 {{{#!ini
     76=== Example Configuration (`sendmail`) ===
     77{{{
    5478[notification]
    5579smtp_enabled = true
     
    6185}}}
    6286
    63 === Customizing the e-mail subject
    64 
     87=== Customizing the e-mail subject ===
    6588The 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:
    6689{{{
    6790$prefix #$ticket.id: $summary
    6891}}}
    69 
    7092The following variables are available in the template:
    7193
     
    7395 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    7496 * `summary`: The ticket summary, with the old value if the summary was edited.
    75  * `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`.
    76 
    77 === Customizing the e-mail content
    78 
    79 The 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:
     97 * `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`.
     98
     99=== Customizing the e-mail content ===
     100
     101The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/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:
    80102
    81103{{{
     
    113135$project.descr
    114136}}}
    115 
    116 == Sample Email
    117 
     137== Sample Email ==
    118138{{{
    119139#42: testing
     
    126146---------------------------+------------------------------------------------
    127147Changes:
    128   * component:  changeset view => search system
     148  * component:  changset view => search system
    129149  * priority:  low => highest
    130150  * owner:  jonas => anonymous
     
    141161}}}
    142162
    143 == Customizing e-mail content for MS Outlook
    144 
    145 MS 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].
     163
     164== Customizing e-mail content for MS Outlook ==
     165
     166Out-of-the-box, MS Outlook normally presents plain text e-mails with a variable-width font; 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].
    146167
    147168Replace the following second row in the template:
     
    150171}}}
    151172
    152 with this (requires Python 2.6 or later):
     173with this instead (''requires Python 2.6 or later''):
    153174{{{
    154175--------------------------------------------------------------------------
     
    164185}}}
    165186
    166 The 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.
     187The 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.
    167188{{{#!div style="margin: 1em 1.75em; border:1px dotted"
    168189{{{#!html
     
    184205Changes:<br />
    185206<br />
    186 &nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     207&nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
    187208&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    188209&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     
    200221}}}
    201222
    202 **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:
     223**Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which shall be part of the mail they have to be added to `sel`, example:
    203224{{{
    204225   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    205226}}}
    206227
    207 However, the solution is still a workaround to an automatically HTML-formatted e-mail.
    208 
    209 == Using GMail as the SMTP relay host
    210 
    211 Use the following configuration snippet:
    212 {{{#!ini
     228However, it's not as perfect as an automatically HTML-formatted e-mail would be, but presented ticket properties are at least readable by default in MS Outlook...
     229
     230
     231== Using GMail as the SMTP relay host ==
     232
     233Use the following configuration snippet
     234{{{
    213235[notification]
    214236smtp_enabled = true
     
    221243}}}
    222244
    223 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     245where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
    224246
    225247Alternatively, you can use `smtp_port = 25`.[[br]]
    226 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.
     248You 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.
    227249 
    228 == Filtering notifications for one's own changes and comments
    229 
    230 To delete these notifications in Gmail, use the following filter:
     250== Filtering notifications for one's own changes ==
     251In Gmail, use the filter:
     252
     253{{{
     254from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
     255}}}
     256
     257For Trac .10, use the filter:
    231258{{{
    232259from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    233260}}}
    234261
    235 In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
     262to delete these notifications.
     263
     264In Thunderbird, there is no such solution if you use IMAP
     265(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
     266
     267The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
     268You will however still get an email if you comment a ticket that you own or have reported.
    236269
    237270You can also add this plugin:
    238 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    239 
    240 == Troubleshooting
     271http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
     272
     273== Troubleshooting ==
    241274
    242275If 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.
    243276
    244 Notification 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.
    245 
    246 === ''Permission denied'' error
     277Notification 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.
     278
     279=== ''Permission denied'' error ===
    247280
    248281Typical error message:
     
    254287}}}
    255288
    256 This 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.
     289This 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.
    257290
    258291Many users get confused when their manual attempts to contact the SMTP server succeed:
    259 {{{#!sh
     292{{{
    260293telnet localhost 25
    261294}}}
    262 
    263 This is because a regular user may connect to the SMTP server, but the web server cannot:
    264 {{{#!sh
     295The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
     296{{{
    265297sudo -u www-data telnet localhost 25
    266298}}}
    267299
    268 In 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.
    269 
    270 Relevant mailing list thread on SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     300In 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.
     301
     302Relevant ML threads:
     303 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    271304
    272305For SELinux in Fedora 10:
    273 {{{#!sh
    274 setsebool -P httpd_can_sendmail 1
    275 }}}
    276 
    277 === ''Suspected spam'' error
     306{{{
     307$ setsebool -P httpd_can_sendmail 1
     308}}}
     309=== ''Suspected spam'' error ===
    278310
    279311Some SMTP servers may reject the notification email sent by Trac.
    280312
    281 The 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.
    282 
    283 Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
     313The 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.
     314
     315Quoted 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.
     316
     317=== ''501, 5.5.4 Invalid Address'' error ===
     318
     319On IIS 6.0 you could get a
     320{{{
     321Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
     322}}}
     323in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
     324
    284325
    285326----
    286 See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]
     327See also: TracTickets, TracIni, TracGuide