Changes between Version 1 and Version 2 of TracNotification

Show
Ignore:
Timestamp:
02/01/11 23:12:19 (3 years ago)
Author:
trac (IP: 127.0.0.1)
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. 
     
    7579}}} 
    7680 
     81== Using GMail as the SMTP relay host == 
     82 
     83Use the following configuration snippet 
     84{{{ 
     85[notification] 
     86smtp_enabled = true 
     87use_tls = true 
     88mime_encoding = base64 
     89smtp_server = smtp.gmail.com 
     90smtp_port = 587 
     91smtp_user = user 
     92smtp_password = password 
     93}}} 
     94 
     95where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com] 
     96 
     97Alternatively, you can use `smtp_port = 25`.[[br]] 
     98You 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. 
     99  
     100== Filtering notifications for one's own changes == 
     101In Gmail, use the filter: 
     102 
     103{{{ 
     104from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)") 
     105}}} 
     106 
     107to delete these notifications. 
     108 
    77109== Troubleshooting == 
    78110 
     
    113145The 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. 
    114146 
    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. 
     147Quoted 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. 
    116148 
    117149----