Changes between Version 4 and Version 5 of TracNotification


Ignore:
Timestamp:
Jun 23, 2016 9:54:23 AM (17 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v4 v5  
    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 When 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 
    13 This 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 
    17 To 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 
    19 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
     11
     12When 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
     16To 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
     18Alternatively, 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.
    2019
    2120When 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`''').
    2221
    23 == Configuring SMTP Notification ==
     22=== Ticket attachment notifications
     23
     24Since 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]
     27trac.ticket.notification.TicketAttachmentNotifier = disabled
     28}}}
     29
     30== Configuring SMTP Notification
    2431
    2532'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    2633
    27 === Configuration Options ===
    28 These 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 
    54 Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    55 
    56 The 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 
    63 The 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 {{{
     34=== Configuration Options
     35
     36These are the available options for the `[notification]` section in `trac.ini`:
     37
     38[[TracIni(notification)]]
     39
     40=== Example Configuration (SMTP)
     41
     42{{{#!ini
    6843[notification]
    6944smtp_enabled = true
     
    7449}}}
    7550
    76 === Example Configuration (`sendmail`) ===
    77 {{{
     51=== Example Configuration (`sendmail`)
     52
     53{{{#!ini
    7854[notification]
    7955smtp_enabled = true
     
    8561}}}
    8662
    87 === Customizing the e-mail subject ===
     63=== Customizing the e-mail subject
     64
    8865The 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:
    8966{{{
    9067$prefix #$ticket.id: $summary
    9168}}}
     69
    9270The following variables are available in the template:
    9371
     
    9573 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    9674 * `summary`: The ticket summary, with the old value if the summary was edited.
    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 
    101 The 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:
     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
     79The 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:
    10280
    10381{{{
     
    135113$project.descr
    136114}}}
    137 == Sample Email ==
     115
     116== Sample Email
     117
    138118{{{
    139119#42: testing
     
    146126---------------------------+------------------------------------------------
    147127Changes:
    148   * component:  changset view => search system
     128  * component:  changeset view => search system
    149129  * priority:  low => highest
    150130  * owner:  jonas => anonymous
     
    161141}}}
    162142
    163 
    164 == Customizing e-mail content for MS Outlook ==
    165 
    166 Out-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].
     143== Customizing e-mail content for MS Outlook
     144
     145MS 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].
    167146
    168147Replace the following second row in the template:
     
    171150}}}
    172151
    173 with this instead (''requires Python 2.6 or later''):
     152with this (requires Python 2.6 or later):
    174153{{{
    175154--------------------------------------------------------------------------
     
    185164}}}
    186165
    187 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.
     166The 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.
    188167{{{#!div style="margin: 1em 1.75em; border:1px dotted"
    189168{{{#!html
     
    205184Changes:<br />
    206185<br />
    207 &nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
     186&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    208187&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    209188&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     
    221200}}}
    222201
    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:
     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:
    224203{{{
    225204   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    226205}}}
    227206
    228 However, 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 
    233 Use the following configuration snippet
    234 {{{
     207However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     208
     209== Using GMail as the SMTP relay host
     210
     211Use the following configuration snippet:
     212{{{#!ini
    235213[notification]
    236214smtp_enabled = true
     
    243221}}}
    244222
    245 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     223where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
    246224
    247225Alternatively, you can use `smtp_port = 25`.[[br]]
    248 You 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.
     226You 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.
    249227 
    250 == Filtering notifications for one's own changes ==
    251 In Gmail, use the filter:
    252 
    253 {{{
    254 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
    255 }}}
    256 
    257 For Trac .10, use the filter:
     228== Filtering notifications for one's own changes and comments
     229
     230To delete these notifications in Gmail, use the following filter:
    258231{{{
    259232from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    260233}}}
    261234
    262 to delete these notifications.
    263 
    264 In Thunderbird, there is no such solution if you use IMAP
    265 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
    266 
    267 The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
    268 You will however still get an email if you comment a ticket that you own or have reported.
     235In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
    269236
    270237You can also add this plugin:
    271 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
    272 
    273 == Troubleshooting ==
     238http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
     239
     240== Troubleshooting
    274241
    275242If 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.
    276243
    277 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.
    278 
    279 === ''Permission denied'' error ===
     244Notification 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
    280247
    281248Typical error message:
     
    287254}}}
    288255
    289 This 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.
     256This 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.
    290257
    291258Many users get confused when their manual attempts to contact the SMTP server succeed:
    292 {{{
     259{{{#!sh
    293260telnet localhost 25
    294261}}}
    295 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    296 {{{
     262
     263This is because a regular user may connect to the SMTP server, but the web server cannot:
     264{{{#!sh
    297265sudo -u www-data telnet localhost 25
    298266}}}
    299267
    300 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 browsing the Trac [trac:MailingList MailingList] archive.
    301 
    302 Relevant ML threads:
    303  * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     268In 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
     270Relevant mailing list thread on SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    304271
    305272For SELinux in Fedora 10:
    306 {{{
    307 $ setsebool -P httpd_can_sendmail 1
    308 }}}
    309 === ''Suspected spam'' error ===
     273{{{#!sh
     274setsebool -P httpd_can_sendmail 1
     275}}}
     276
     277=== ''Suspected spam'' error
    310278
    311279Some SMTP servers may reject the notification email sent by Trac.
    312280
    313 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, it is recommended to change the default encoding to "quoted-printable" using the `mime_encoding` option.
    314 
    315 Quoted 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 
    319 On IIS 6.0 you could get a
    320 {{{
    321 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
    322 }}}
    323 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
    324 
     281The 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
     283Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    325284
    326285----
    327 See also: TracTickets, TracIni, TracGuide
     286See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]