| 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: |
| 38 | | * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. |
| 39 | | * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64) |
| 40 | | * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered. |
| 41 | | |
| 42 | | Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. |
| 43 | | |
| 44 | | === Example Configuration === |
| 45 | | |
| | 26 | These are the available options for the `[notification]` section in trac.ini. |
| | 27 | |
| | 28 | * '''`smtp_enabled`''': Enable email notification. |
| | 29 | * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails. |
| | 30 | * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails. |
| | 31 | * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails. |
| | 32 | * '''`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. |
| | 33 | * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' |
| | 34 | * '''`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 |
| | 35 | * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default. |
| | 36 | * '''`always_notify_reporter`''': Always send notifications to any address in the reporter field (default: false). |
| | 37 | * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false). |
| | 38 | * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true). |
| | 39 | * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). |
| | 40 | * '''`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. |
| | 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. |
| | 45 | * '''`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. |
| | 49 | |
| | 50 | Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. |
| | 51 | |
| | 52 | The following options are specific to email delivery through SMTP. |
| | 53 | * '''`smtp_server`''': SMTP server used for notification messages. |
| | 54 | * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server. |
| | 55 | * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account. |
| | 56 | * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account. |
| | 57 | * '''`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. |
| | 58 | |
| | 59 | The 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. |
| | 61 | |
| | 62 | === Example Configuration (SMTP) === |
| | 72 | === Example Configuration (`sendmail`) === |
| | 73 | {{{ |
| | 74 | [notification] |
| | 75 | smtp_enabled = true |
| | 76 | email_sender = SendmailEmailSender |
| | 77 | sendmail_path = /usr/sbin/sendmail |
| | 78 | smtp_from = notifier@example.com |
| | 79 | smtp_replyto = myproj@projects.example.com |
| | 80 | smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com |
| | 81 | }}} |
| | 82 | |
| | 83 | === Customizing the e-mail subject === |
| | 84 | The 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: |
| | 85 | {{{ |
| | 86 | $prefix #$ticket.id: $summary |
| | 87 | }}} |
| | 88 | The following variables are available in the template: |
| | 89 | |
| | 90 | * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]). |
| | 91 | * `prefix`: The prefix defined in `smtp_subject_prefix`. |
| | 92 | * `summary`: The ticket summary, with the old value if the summary was edited. |
| | 93 | * `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`. |
| | 94 | |
| | 95 | === Customizing the e-mail content === |
| | 96 | |
| | 97 | The 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: |
| | 98 | |
| | 99 | {{{ |
| | 100 | $ticket_body_hdr |
| | 101 | $ticket_props |
| | 102 | #choose ticket.new |
| | 103 | #when True |
| | 104 | $ticket.description |
| | 105 | #end |
| | 106 | #otherwise |
| | 107 | #if changes_body |
| | 108 | Changes (by $change.author): |
| | 109 | |
| | 110 | $changes_body |
| | 111 | #end |
| | 112 | #if changes_descr |
| | 113 | #if not changes_body and not change.comment and change.author |
| | 114 | Description changed by $change.author: |
| | 115 | #end |
| | 116 | $changes_descr |
| | 117 | -- |
| | 118 | #end |
| | 119 | #if change.comment |
| | 120 | |
| | 121 | Comment${not changes_body and '(by %s)' % change.author or ''}: |
| | 122 | |
| | 123 | $change.comment |
| | 124 | #end |
| | 125 | #end |
| | 126 | #end |
| | 127 | |
| | 128 | -- |
| | 129 | Ticket URL: <$ticket.link> |
| | 130 | $project.name <${project.url or abs_href()}> |
| | 131 | $project.descr |
| | 132 | }}} |
