Changes between Version 1 and Version 2 of TracNotification


Ignore:
Timestamp:
Feb 24, 2010 5:37:18 PM (9 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_port''': (''since 0.9'') Port used to contact the SMTP server.
    22  * '''smtp_user''': (''since 0.9'') User name for authentication SMTP account.
    23  * '''smtp_password''': (''since 0.9'') Password for authentication SMTP account.
    24  * '''smtp_from''': Email address to use for ''Sender''-headers in notification emails.
    25  * '''smtp_from_name''': Sender name to use for ''Sender''-headers in notification emails.
    26  * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails.
    27  * '''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.
    28  * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    29  * '''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
    30  * '''smtp_subject_prefix''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
    31  * '''always_notify_reporter''':  Always send notifications to any address in the reporter field (default: false).
    32  * '''always_notify_owner''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
    33  * '''always_notify_updater''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
    34  * '''use_public_cc''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    35  * '''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.
    36  * '''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.
    37  * '''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:
    3844   * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    3945   * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    4046   * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
    41 
    42 Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    43 
    44 === Example Configuration ===
    45 
     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 * '''`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:
     49   * `SmtpEmailSender`: connects to an SMTP server (default).
     50   * `SendmailEmailSender`: runs a `sendmail`-compatible executable.
     51
     52Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
     53
     54The following options are specific to email delivery through SMTP.
     55 * '''`smtp_server`''': SMTP server used for notification messages.
     56 * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
     57 * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
     58 * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
     59 * '''`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.
     60
     61The following option is specific to email delivery through a `sendmail`-compatible executable.
     62 * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options.
     63
     64=== Example Configuration (SMTP) ===
    4665{{{
    4766[notification]
     
    5372}}}
    5473
     74=== Example Configuration (`sendmail`) ===
     75{{{
     76[notification]
     77smtp_enabled = true
     78email_sender = SendmailEmailSender
     79sendmail_path = /usr/sbin/sendmail
     80smtp_from = notifier@example.com
     81smtp_replyto = myproj@projects.example.com
     82smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     83}}}
     84
     85=== Customizing the e-mail subject ===
     86The 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:
     87{{{
     88$prefix #$ticket.id: $summary
     89}}}
     90The following variables are available in the template:
     91
     92 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     93 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     94 * `summary`: The ticket summary, with the old value if the summary was edited.
     95 * `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`.
     96
     97=== Customizing the e-mail content ===
     98
     99The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`.  The default looks like this:
     100
     101{{{
     102$ticket_body_hdr
     103$ticket_props
     104#choose ticket.new
     105  #when True
     106$ticket.description
     107  #end
     108  #otherwise
     109    #if changes_body
     110Changes (by $change.author):
     111
     112$changes_body
     113    #end
     114    #if changes_descr
     115      #if not changes_body and not change.comment and change.author
     116Description changed by $change.author:
     117      #end
     118$changes_descr
     119--
     120    #end
     121    #if change.comment
     122
     123Comment${not changes_body and '(by %s)' % change.author or ''}:
     124
     125$change.comment
     126    #end
     127  #end
     128#end
     129
     130--
     131Ticket URL: <$ticket.link>
     132$project.name <${project.url or abs_href()}>
     133$project.descr
     134}}}
    55135== Sample Email ==
    56136{{{
     
    105185}}}
    106186
     187For Trac .10, use the filter:
     188{{{
     189from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     190}}}
     191
    107192to delete these notifications.
     193
     194In Thunderbird, there is no such solution if you use IMAP
     195(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
     196
     197The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
     198You will however still get an email if you comment a ticket that you own or have reported.
     199
     200You can also add this plugin:
     201http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
    108202
    109203== Troubleshooting ==
     
    134228}}}
    135229
    136 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.
     230In 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.
    137231
    138232Relevant ML threads:
    139233 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    140  
     234
     235For SELinux in Fedora 10:
     236{{{
     237$ setsebool -P httpd_can_sendmail 1
     238}}}
    141239=== ''Suspected spam'' error ===
    142240
     
    146244
    147245Quoted 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.
     246
     247=== ''501, 5.5.4 Invalid Address'' error ===
     248
     249On IIS 6.0 you could get a
     250{{{
     251Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
     252}}}
     253in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
     254
    148255
    149256----