Changes between Version 1 and Version 2 of TracNotification


Ignore:
Timestamp:
Jul 9, 2009, 4:57:37 PM (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v1 v2  
    1919 * '''smtp_enabled''': Enable email notification.
    2020 * '''smtp_server''': SMTP server used for notification messages.
     21 * '''smtp_port''': (''since 0.9'') Port used to contact the SMTP server.
    2122 * '''smtp_user''': (''since 0.9'') User name for authentication SMTP account.
    2223 * '''smtp_password''': (''since 0.9'') Password for authentication SMTP account.
    2324 * '''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.
    2426 * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails.
    2527 * '''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.
    2628 * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    2729 * '''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.
     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).
    3134 * '''use_public_cc''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    3235 * '''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.
    3337 * '''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:
    3438   * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    3539   * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    3640   * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
     41 * '''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.
    3742
    3843Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    … …  
    4853smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
    4954}}}
     55
     56=== Customizing the e-mail subject ===
     57The 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:
     58{{{
     59$prefix #$ticket.id: $summary
     60}}}
     61The following variables are available in the template:
     62
     63 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     64 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     65 * `summary`: The ticket summary, with the old value if the summary was edited.
     66 * `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`.
    5067
    5168== Sample Email ==
    … …  
    7491My Project <http://myproj.example.com/>
    7592}}}
     93
     94== Using GMail as the SMTP relay host ==
     95
     96Use the following configuration snippet
     97{{{
     98[notification]
     99smtp_enabled = true
     100use_tls = true
     101mime_encoding = base64
     102smtp_server = smtp.gmail.com
     103smtp_port = 587
     104smtp_user = user
     105smtp_password = password
     106}}}
     107
     108where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     109
     110Alternatively, you can use `smtp_port = 25`.[[br]]
     111You 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.
     112 
     113== Filtering notifications for one's own changes ==
     114In Gmail, use the filter:
     115
     116{{{
     117from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
     118}}}
     119
     120to delete these notifications.
     121
     122In Thunderbird, there is no such solution if you use IMAP
     123(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
     124
     125The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
     126You will however still get an email if you comment a ticket that you own or have reported.
     127
     128You can also add this plugin:
     129http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
    76130
    77131== Troubleshooting ==
    … …  
    102156}}}
    103157
    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.
     158In 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.
    105159
    106160Relevant ML threads:
    … …  
    113167The 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.
    114168
    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.
     169Quoted 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.
    116170
    117171----