Changes between Version 5 and Version 6 of TracNotification


Ignore:
Timestamp:
03/24/15 23:15:03 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v5 v6  
    99
    1010== 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 will automatically send you an email when changes are made to the ticket, depending on how notification is configured.
     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.
    1214
    1315=== How to use your username to receive notification mails ===
    1416
    15 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.
    16 
    17 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.
     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.
    1820
    1921When 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`''').
    2022
    21 === Ticket attachment notifications
    22 
    23 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:
    24 {{{#!ini
    25 [components]
    26 trac.ticket.notification.TicketAttachmentNotifier = disabled
    27 }}}
    28 
    2923== Configuring SMTP Notification ==
    3024
     
    3226
    3327=== Configuration Options ===
    34 These are the available options for the `[notification]` section in trac.ini:
    35 
    36 [[TracIni(notification)]]
     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.
    3765
    3866=== Example Configuration (SMTP) ===
     
    6795 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    6896 * `summary`: The ticket summary, with the old value if the summary was edited.
    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`.
     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`.
    7098
    7199=== Customizing the e-mail content ===
    72100
    73 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:
     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:
    74102
    75103{{{
     
    107135$project.descr
    108136}}}
    109 
    110137== Sample Email ==
    111138{{{
     
    119146---------------------------+------------------------------------------------
    120147Changes:
    121   * component:  changeset view => search system
     148  * component:  changset view => search system
    122149  * priority:  low => highest
    123150  * owner:  jonas => anonymous
     
    134161}}}
    135162
     163
    136164== Customizing e-mail content for MS Outlook ==
    137165
    138 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].
     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].
    139167
    140168Replace the following second row in the template:
     
    143171}}}
    144172
    145 with this (requires Python 2.6 or later):
     173with this instead (''requires Python 2.6 or later''):
    146174{{{
    147175--------------------------------------------------------------------------
     
    157185}}}
    158186
    159 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.
    160188{{{#!div style="margin: 1em 1.75em; border:1px dotted"
    161189{{{#!html
     
    177205Changes:<br />
    178206<br />
    179 &nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     207&nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
    180208&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    181209&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     
    193221}}}
    194222
    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:
     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:
    196224{{{
    197225   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    198226}}}
    199227
    200 However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     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
    201230
    202231== Using GMail as the SMTP relay host ==
    203232
    204 Use the following configuration snippet:
     233Use the following configuration snippet
    205234{{{
    206235[notification]
     
    214243}}}
    215244
    216 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]
    217246
    218247Alternatively, you can use `smtp_port = 25`.[[br]]
    219 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.
    220249 
    221 == Filtering notifications for one's own changes and comments ==
     250== Filtering notifications for one's own changes ==
    222251In Gmail, use the filter:
     252
     253{{{
     254from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
     255}}}
     256
     257For Trac .10, use the filter:
    223258{{{
    224259from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     
    227262to delete these notifications.
    228263
    229 In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
     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.
    230269
    231270You can also add this plugin:
    232 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
     271http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
    233272
    234273== Troubleshooting ==
     
    236275If 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.
    237276
    238 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.
     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.
    239278
    240279=== ''Permission denied'' error ===
     
    248287}}}
    249288
    250 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.
    251290
    252291Many users get confused when their manual attempts to contact the SMTP server succeed:
     
    254293telnet localhost 25
    255294}}}
    256 This is because a regular user may connect to the SMTP server, but the web server cannot:
     295The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    257296{{{
    258297sudo -u www-data telnet localhost 25
    259298}}}
    260299
    261 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.
     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.
    262301
    263302Relevant ML threads:
     
    268307$ setsebool -P httpd_can_sendmail 1
    269308}}}
    270 
    271309=== ''Suspected spam'' error ===
    272310
    273311Some SMTP servers may reject the notification email sent by Trac.
    274312
    275 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.
    276 
    277 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
    278325
    279326----
    280 See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]
     327See also: TracTickets, TracIni, TracGuide