Changes between Version 2 and Version 3 of TracNotification


Ignore:
Timestamp:
Jul 22, 2015, 9:31:22 AM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v2 v3  
    2828These are the available options for the `[notification]` section in trac.ini.
    2929
    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.
     30[[TracIni(notification)]]
    6431
    6532=== Example Configuration (SMTP) ===
     
    170137}}}
    171138
    172 with this instead:
     139with this instead (''requires Python 2.6 or later''):
    173140{{{
    174141--------------------------------------------------------------------------
     
    220187}}}
    221188
    222 However, it's not as perfect as an HTML formatted e-mail would be, but presented ticket properties are at least readable...
     189**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:
     190{{{
     191   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     192}}}
     193
     194However, 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...
    223195
    224196
     
    240212
    241213Alternatively, 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.
     214You 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 [trac:comment:2:ticket:7107 #7107] for details.
    243215 
    244 == Filtering notifications for one's own changes ==
     216== Filtering notifications for one's own changes and comments ==
    245217In Gmail, use the filter:
    246218
    247 {{{
    248 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
    249 }}}
    250 
    251 For Trac .10, use the filter:
    252219{{{
    253220from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     
    259226(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
    260227
    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.
    263 
    264228You can also add this plugin:
    265 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
     229http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    266230
    267231== Troubleshooting ==