Changes between Version 1 and Version 2 of TracNotification

Show
Ignore:
Timestamp:
06/10/10 13:36:29 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v1 v2  
    22[[TracGuideToc]] 
    33 
     4[[PageOutline]] 
     5 
    46Trac supports notification about ticket changes via email.  
    57 
     
    911 
    1012== 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). 
     13When 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). 
    1214 
    1315This is useful to keep up-to-date on an issue or enhancement request that interests you. 
    1416 
     17=== How to use your username to receive notification mails === 
     18 
     19To 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.  
     20 
     21Alternatively, 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. 
     22 
    1523== Configuring SMTP Notification == 
    1624 
     25'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].  
     26 
    1727=== 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_user''': (''since 0.9'') User name for authentication SMTP account. 
    22  * '''smtp_password''': (''since 0.9'') Password for authentication SMTP account. 
    23  * '''smtp_from''': Email address to use for ''Sender''-headers in notification emails. 
    24  * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails. 
    25  * '''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. 
    26  * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' 
    27  * '''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  
    28  * '''always_notify_reporter''':  Always send notifications to any address in the reporter field. 
    29  * '''always_notify_owner''': (''since 0.9'') Always send notifications to the address in the owner field. 
    30  * '''always_notify_updater''': (''since 0.10'') Always send a notification to the updater of a ticket. 
    31  * '''use_public_cc''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). 
    32  * '''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.  
    33  * '''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: 
     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_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 * '''`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: 
    3444   * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. 
    3545   * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64) 
    3646   * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.  
    37  
    38 Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
    39  
    40 === Example Configuration === 
    41  
     47 * '''`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. 
     48 
     49Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
     50 
     51The following options are specific to email delivery through SMTP. 
     52 * '''`smtp_server`''': SMTP server used for notification messages. 
     53 * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server. 
     54 * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account. 
     55 * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account. 
     56 * '''`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. 
     57 
     58 
     59=== Example Configuration (SMTP) === 
    4260{{{ 
    4361[notification] 
     
    4967}}} 
    5068 
     69 
     70=== Customizing the e-mail subject === 
     71The 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: 
     72{{{ 
     73$prefix #$ticket.id: $summary 
     74}}} 
     75The following variables are available in the template: 
     76 
     77 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]). 
     78 * `prefix`: The prefix defined in `smtp_subject_prefix`. 
     79 * `summary`: The ticket summary, with the old value if the summary was edited. 
     80 * `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`. 
     81 
     82=== Customizing the e-mail content === 
     83 
     84The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`.  The default looks like this: 
     85 
     86{{{ 
     87$ticket_body_hdr 
     88$ticket_props 
     89#choose ticket.new 
     90  #when True 
     91$ticket.description 
     92  #end 
     93  #otherwise 
     94    #if changes_body 
     95Changes (by $change.author): 
     96 
     97$changes_body 
     98    #end 
     99    #if changes_descr 
     100      #if not changes_body and not change.comment and change.author 
     101Description changed by $change.author: 
     102      #end 
     103$changes_descr 
     104-- 
     105    #end 
     106    #if change.comment 
     107 
     108Comment${not changes_body and '(by %s)' % change.author or ''}: 
     109 
     110$change.comment 
     111    #end 
     112  #end 
     113#end 
     114 
     115--  
     116Ticket URL: <$ticket.link> 
     117$project.name <${project.url or abs_href()}> 
     118$project.descr 
     119}}} 
    51120== Sample Email == 
    52121{{{ 
     
    75144}}} 
    76145 
     146== Using GMail as the SMTP relay host == 
     147 
     148Use the following configuration snippet 
     149{{{ 
     150[notification] 
     151smtp_enabled = true 
     152use_tls = true 
     153mime_encoding = base64 
     154smtp_server = smtp.gmail.com 
     155smtp_port = 587 
     156smtp_user = user 
     157smtp_password = password 
     158}}} 
     159 
     160where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com] 
     161 
     162Alternatively, you can use `smtp_port = 25`.[[br]] 
     163You 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. 
     164  
     165== Filtering notifications for one's own changes == 
     166In Gmail, use the filter: 
     167 
     168{{{ 
     169from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)") 
     170}}} 
     171 
     172For Trac .10, use the filter: 
     173{{{ 
     174from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)") 
     175}}} 
     176 
     177to delete these notifications. 
     178 
     179In Thunderbird, there is no such solution if you use IMAP 
     180(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body). 
     181 
     182The best you can do is to set "always_notify_updater" in conf/trac.ini to false. 
     183You will however still get an email if you comment a ticket that you own or have reported. 
     184 
     185You can also add this plugin: 
     186http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin 
     187 
    77188== Troubleshooting == 
    78189 
     
    102213}}} 
    103214 
    104 In such a case, you need to configure your server so that the web server is authorize 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 MailingList archive. 
     215In 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. 
    105216 
    106217Relevant ML threads: 
    107218 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 
    108   
     219 
     220For SELinux in Fedora 10: 
     221{{{ 
     222$ setsebool -P httpd_can_sendmail 1 
     223}}} 
    109224=== ''Suspected spam'' error === 
    110225 
     
    113228The 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. 
    114229 
    115 Quoted printable enconding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended to stick with the Base64 encoding. 
     230Quoted 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. 
     231 
     232=== ''501, 5.5.4 Invalid Address'' error === 
     233 
     234On IIS 6.0 you could get a  
     235{{{ 
     236Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address') 
     237}}} 
     238in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it. 
     239 
    116240 
    117241----