Changes between Version 3 and Version 4 of TracNotification


Ignore:
Timestamp:
Jun 4, 2009, 10:42:38 AM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v3 v4  
    1616
    1717=== 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:
     18These are the available options for the `[notification]` section in trac.ini.
     19
     20 * '''`smtp_enabled`''': Enable email notification.
     21 * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails.
     22 * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails.
     23 * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
     24 * '''`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.
     25 * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
     26 * '''`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
     27 * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
     28 * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false).
     29 * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
     30 * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
     31 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
     32 * '''`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.
     33 * '''`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:
    3834   * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    3935   * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    4036   * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
     37 * '''`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.
     38 * '''`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:
     39   * `SmtpEmailSender`: connects to an SMTP server (default).
     40   * `SendmailEmailSender`: runs a `sendmail`-compatible executable.
    4141
    42 Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
     42Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    4343
    44 === Example Configuration ===
     44The following options are specific to email delivery through SMTP.
     45 * '''`smtp_server`''': SMTP server used for notification messages.
     46 * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
     47 * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
     48 * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
     49 * '''`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.
    4550
     51The following option is specific to email delivery through a `sendmail`-compatible executable.
     52 * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options.
     53
     54=== Example Configuration (SMTP) ===
    4655{{{
    4756[notification]
     
    5261smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
    5362}}}
     63
     64=== Example Configuration (`sendmail`) ===
     65{{{
     66[notification]
     67smtp_enabled = true
     68email_sender = SendmailEmailSender
     69sendmail_path = /usr/sbin/sendmail
     70smtp_from = notifier@example.com
     71smtp_replyto = myproj@projects.example.com
     72smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     73}}}
     74
     75=== Customizing the e-mail subject ===
     76The 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:
     77{{{
     78$prefix #$ticket.id: $summary
     79}}}
     80The following variables are available in the template:
     81
     82 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     83 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     84 * `summary`: The ticket summary, with the old value if the summary was edited.
     85 * `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`.
    5486
    5587== Sample Email ==