Changes between Version 1 and Version 2 of TracNotification


Ignore:
Timestamp:
2011-01-15 11:36:22 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v1 v2  
    22[[TracGuideToc]] 
    33 
    4 [[PageOutline]] 
    5  
    6 Trac supports notification about ticket changes via email.  
     4Trac supports notification of ticket changes via email.  
    75 
    86Email notification is useful to keep users up-to-date on tickets/issues of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list. For example, this is how the [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] mailing list is set up. 
    … …  
    4139 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). 
    4240 * '''`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: 
    44    * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. 
    45    * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64) 
    46    * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.  
     41 * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values: 
     42   * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.  
     43   * `base64`: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. 
     44   * `qp` or `quoted-printable`: best for european languages (more compact than base64) if 8bit encoding cannot be used. 
    4745 * '''`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. 
     46 * '''`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: 
     47   * `SmtpEmailSender`: connects to an SMTP server (default). 
     48   * `SendmailEmailSender`: runs a `sendmail`-compatible executable. 
    4849 
    4950Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
    … …  
    5657 * '''`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. 
    5758 
     59The following option is specific to email delivery through a `sendmail`-compatible executable. 
     60 * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options. 
    5861 
    5962=== Example Configuration (SMTP) === 
    … …  
    6770}}} 
    6871 
     72=== Example Configuration (`sendmail`) === 
     73{{{ 
     74[notification] 
     75smtp_enabled = true 
     76email_sender = SendmailEmailSender 
     77sendmail_path = /usr/sbin/sendmail 
     78smtp_from = notifier@example.com 
     79smtp_replyto = myproj@projects.example.com 
     80smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com 
     81}}} 
    6982 
    7083=== Customizing the e-mail subject === 
    … …  
    8295=== Customizing the e-mail content === 
    8396 
    84 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`.  The default looks like this: 
     97The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`.  You can add your own version of this template by adding a `ticket_notify_email.txt` to the templates directory of your environment. The default looks like this: 
    8598 
    8699{{{