| 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_user''': (''since 0.9'') User name for authentication SMTP account. |
| 22 | | * '''smtp_password''': (''since 0.9'') Password for authentication SMTP account. |
| 23 | | * '''smtp_from''': Email address to use for ''Sender''-headers in notification emails. |
| 24 | | * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails. |
| 25 | | * '''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. |
| 26 | | * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' |
| 27 | | * '''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. |
| 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: |
| | 18 | These 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: |
| | 63 | |
| | 64 | === Example Configuration (`sendmail`) === |
| | 65 | {{{ |
| | 66 | [notification] |
| | 67 | smtp_enabled = true |
| | 68 | email_sender = SendmailEmailSender |
| | 69 | sendmail_path = /usr/sbin/sendmail |
| | 70 | smtp_from = notifier@example.com |
| | 71 | smtp_replyto = myproj@projects.example.com |
| | 72 | smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com |
| | 73 | }}} |
| | 74 | |
| | 75 | === Customizing the e-mail subject === |
| | 76 | 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: |
| | 77 | {{{ |
| | 78 | $prefix #$ticket.id: $summary |
| | 79 | }}} |
| | 80 | The 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`. |
| | 112 | |
| | 113 | == Using GMail as the SMTP relay host == |
| | 114 | |
| | 115 | Use the following configuration snippet |
| | 116 | {{{ |
| | 117 | [notification] |
| | 118 | smtp_enabled = true |
| | 119 | use_tls = true |
| | 120 | mime_encoding = base64 |
| | 121 | smtp_server = smtp.gmail.com |
| | 122 | smtp_port = 587 |
| | 123 | smtp_user = user |
| | 124 | smtp_password = password |
| | 125 | }}} |
| | 126 | |
| | 127 | where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com] |
| | 128 | |
| | 129 | Alternatively, you can use `smtp_port = 25`.[[br]] |
| | 130 | 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. |
| | 131 | |
| | 132 | == Filtering notifications for one's own changes == |
| | 133 | In Gmail, use the filter: |
| | 134 | |
| | 135 | {{{ |
| | 136 | from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)") |
| | 137 | }}} |
| | 138 | |
| | 139 | to delete these notifications. |
| | 140 | |
| | 141 | In Thunderbird, there is no such solution if you use IMAP |
| | 142 | (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body). |
| | 143 | |
| | 144 | The best you can do is to set "always_notify_updater" in conf/trac.ini to false. |
| | 145 | You will however still get an email if you comment a ticket that you own or have reported. |
| | 146 | |
| | 147 | You can also add this plugin: |
| | 148 | http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin |
