Changes between Version 4 and Version 5 of TracNotification


Ignore:
Timestamp:
Mar 25, 2015, 3:59:42 PM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v4 v5  
    99
    1010== 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.
     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.
    1412
    1513=== How to use your username to receive notification mails ===
    1614
    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.
     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.
    2018
    2119When 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`''').
    2220
     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
    2329== Configuring SMTP Notification ==
    2430
    … …  
    2632
    2733=== 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_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
    34  * '''`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.
    35  * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    36  * '''`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
    37  * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
    38  * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false).
    39  * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
    40  * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
    41  * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    42  * '''`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.
    43  * '''`ignore_domains`''': Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).
    44  * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values:
    45    * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.
    46    * `base64`: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    47    * `qp` or `quoted-printable`: best for european languages (more compact than base64) if 8bit encoding cannot be used.
    48  * '''`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.
    49  * '''`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:
    50    * `SmtpEmailSender`: connects to an SMTP server (default).
    51    * `SendmailEmailSender`: runs a `sendmail`-compatible executable.   
    52 
    53 Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    54 
    55 The following options are specific to email delivery through SMTP.
    56  * '''`smtp_server`''': SMTP server used for notification messages.
    57  * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
    58  * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
    59  * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
    60  * '''`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.
    61 
    62 The following option is specific to email delivery through a `sendmail`-compatible executable.
    63  * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options.
     34These are the available options for the `[notification]` section in trac.ini:
     35
     36[[TracIni(notification)]]
    6437
    6538=== Example Configuration (SMTP) ===
    … …  
    9467 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    9568 * `summary`: The ticket summary, with the old value if the summary was edited.
    96  * `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`.
     69 * `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`.
    9770
    9871=== Customizing the e-mail content ===
    9972
    100 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:
     73The 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:
    10174
    10275{{{
    … …  
    134107$project.descr
    135108}}}
     109
    136110== Sample Email ==
    137111{{{
    … …  
    145119---------------------------+------------------------------------------------
    146120Changes:
    147   * component:  changset view => search system
     121  * component:  changeset view => search system
    148122  * priority:  low => highest
    149123  * owner:  jonas => anonymous
    … …  
    160134}}}
    161135
    162 
    163136== Customizing e-mail content for MS Outlook ==
    164137
    165 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].
     138MS 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].
    166139
    167140Replace the following second row in the template:
    … …  
    170143}}}
    171144
    172 with this instead:
     145with this (requires Python 2.6 or later):
    173146{{{
    174147--------------------------------------------------------------------------
    … …  
    184157}}}
    185158
    186 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.
     159The 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.
    187160{{{#!div style="margin: 1em 1.75em; border:1px dotted"
    188161{{{#!html
    … …  
    204177Changes:<br />
    205178<br />
    206 &nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
     179&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    207180&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    208181&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
    … …  
    220193}}}
    221194
    222 However, it's not as perfect as an HTML formatted e-mail would be, but presented ticket properties are at least readable...
    223 
     195**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:
     196{{{
     197   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     198}}}
     199
     200However, the solution is still a workaround to an automatically HTML-formatted e-mail.
    224201
    225202== Using GMail as the SMTP relay host ==
    226203
    227 Use the following configuration snippet
     204Use the following configuration snippet:
    228205{{{
    229206[notification]
    … …  
    237214}}}
    238215
    239 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     216where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
    240217
    241218Alternatively, you can use `smtp_port = 25`.[[br]]
    242 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.
     219You 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.
    243220 
    244 == Filtering notifications for one's own changes ==
     221== Filtering notifications for one's own changes and comments ==
    245222In Gmail, use the filter:
    246 
    247 {{{
    248 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
    249 }}}
    250 
    251 For Trac .10, use the filter:
    252223{{{
    253224from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    … …  
    256227to delete these notifications.
    257228
    258 In Thunderbird, there is no such solution if you use IMAP
    259 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
    260 
    261 The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
    262 You will however still get an email if you comment a ticket that you own or have reported.
     229In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
    263230
    264231You can also add this plugin:
    265 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
     232http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    266233
    267234== Troubleshooting ==
    … …  
    269236If 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.
    270237
    271 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.
     238Notification 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.
    272239
    273240=== ''Permission denied'' error ===
    … …  
    281248}}}
    282249
    283 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.
     250This 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.
    284251
    285252Many users get confused when their manual attempts to contact the SMTP server succeed:
    … …  
    287254telnet localhost 25
    288255}}}
    289 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
     256This is because a regular user may connect to the SMTP server, but the web server cannot:
    290257{{{
    291258sudo -u www-data telnet localhost 25
    292259}}}
    293260
    294 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.
     261In 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.
    295262
    296263Relevant ML threads:
    … …  
    301268$ setsebool -P httpd_can_sendmail 1
    302269}}}
     270
    303271=== ''Suspected spam'' error ===
    304272
    305273Some SMTP servers may reject the notification email sent by Trac.
    306274
    307 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.
    308 
    309 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.
    310 
    311 === ''501, 5.5.4 Invalid Address'' error ===
    312 
    313 On IIS 6.0 you could get a
    314 {{{
    315 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
    316 }}}
    317 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
    318 
     275The 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.
     276
     277Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    319278
    320279----
    321 See also: TracTickets, TracIni, TracGuide
     280See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]