Changes between Version 1 and Version 2 of TracNotification


Ignore:
Timestamp:
08/27/15 23:20:06 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v1 v2  
    1 = チケット更新情報のメール通知 =
     1= Email Notification of Ticket Changes
    22[[TracGuideToc]]
    33
    4 Trac はチケット更新情報をメールで通知出来ます。
    5 
    6 メールによる更新通知は、ユーザに関係するチケットについての最新情報を随時に提供したり、専用 ML にチケットの更新情報を配信したりするのに便利な機能です。例えば、 [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] を見るとどのようにセットアップされているか見ることができます。
    7 
    8 通知機能はデフォルトでは無効になっています。有効化とコンフィグレーションは [wiki:TracIni trac.ini] で行うことができます。
    9 
    10 == メール通知を受け取る ==
    11 新しいチケットを登録したりコメントを追加する際、 ''報告者'' 、 ''担当者'' もしくは ''関係者'' フィールドに有効なメールアドレスを入力してください。チケットに更新があると、 Trac が自動的にメールを送信します。 (どのように通知メール機能を設定しているかによります)
    12 
    13 これは、興味のあるチケットや機能追加に関する最新情報を随時受け取りたい場合に便利な機能です。
    14 
    15 == SMTP 通知のコンフィグレーション ==
    16 
    17 === コンフィグレーション オプション ===
    18 trac.ini の ''[notification]'' セクションで設定できるオプションです。
    19 [[BR]](訳注: 0.10 以降では `TracIni` マクロを使用することで正確なオプション一覧を取得できます。以下のリストは必要に応じて `[[TracIni(notification)]]` に置き換えて使用してください。)
    20  * '''smtp_enabled''': メール通知を有効にします。
    21  * '''smtp_server''': 通知メッセージに使用されるSMTPサーバ。
    22  * '''smtp_user''': (''0.9'' 以降) SMTP認証アカウントのユーザID。
    23  * '''smtp_password''': (''0.9 以降'') SMTP認証アカウントのパスワード。
    24  * '''smtp_from''': 通知メールの''Sender''-ヘッダに使用するメールアドレス。
    25  * '''smtp_replyto''': 通知メールの''Reply-To''-ヘッダに使用するメールアドレス
    26  * '''smtp_default_domain''': (''0.10 以降'') ドメイン名を含んでいないアドレスに特定のドメイン名を追加します。完全修飾されたアドレスは修正されません。ユーザの設定からメールアドレスが分からないときに、デフォルトドメインをすべてのユーザ名 / ログイン名に追加します。
    27  * '''smtp_always_cc''': 常に通知メールを送信するメールアドレスのリスト。 ''主に専用MLにチケット更新を通知するのに使用されます。''
    28  * '''smtp_always_bcc''': (''0.10 以降'') 常に通知メールを送信するメールアドレスの一覧。ただし、通知メールの他の受信者からメールアドレスが見えません。
    29  * '''always_notify_reporter''': 報告者フィールドのすべてのメールアドレスに常に通知メールを送信します。
    30  * '''always_notify_owner''': (''0.9 以降'') 担当者フィールドのメールアドレスに常に通知メールを送信します。
    31  * '''always_notify_updater''': (''0.10 以降'') チケットの更新者に常に通知メールを送信します。
    32  * '''use_public_cc''': (''0.10 以降'') To: (担当者, 報告者) と CC: のアドレスのリストがすべての受信者に見えるかどうかを設定します ( デフォルトは ''Bcc:'' で見えません)
    33  * '''use_short_addr''': (''0.10 以降'') 通知メールの配信でメールアドレスがドメイン名を含むようにするかどうかを設定します (例 ''@<domain.com>'' で終わらないようにする)。このオプションは SMTP サーバがローカルアドレスをハンドリングでき、ローカルのメールボックスとユーザ名/ログイン名をマップできるような環境、イントラネット内で使用するときに便利です。
    34  * '''mime_encoding''': (''0.10 以降'') 通知メールは常に 7-bit モードで送信されます。このオプションで MIME エンコードの選択ができます。利用可能な値は以下の通りです:
    35    * `base64`: デフォルトの値です。どのような種類の内容にも対応できます。 デリケートな アンチスパム / アンチウイルス エンジンにひっかかるかもしれません。
    36    * `qp` または `quoted-printable`: ヨーロッパの言語に適しています。 (base64 よりコンパクトです) non-ASCII テキストには推奨できません。 (base64 のほうがコンパクトになります )
    37    * `none`: エンコードしません。英語のみ (ASCII) で使用できます。 non-ASCII 文字を含んでいるメールは配信されないでしょう。
    38 
    39 '''smtp_from''' か '''smtp_replyto''' の一方 (もしくは両方) が ''必ず'' 設定されていなければなりません。設定されていない場合、 Trac は通知メールの送信を拒否します。
    40 
    41 === コンフィグレーション例 ===
    42 
    43 {{{
     4Trac supports notification of ticket changes via email.
     5
     6Email 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.
     7
     8Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
     9
     10== Receiving Notification Mails
     11
     12When reporting a new ticket or adding a comment, enter a valid email address or your Trac username in the ''reporter'', ''assigned to/owner'' or ''cc'' field. Trac will automatically send you an email when changes are made to the ticket, depending on how notification is configured.
     13
     14=== How to use your username to receive notification mails
     15
     16To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page.
     17
     18Alternatively, a default domain name ('''`smtp_default_domain`''') can be set in the TracIni file, see [#ConfigurationOptions Configuration Options] below. In this case, the default domain will be appended to the username, which can be useful for an "Intranet" kind of installation.
     19
     20When using apache and mod_kerb for authentication against Kerberos / Active Directory, usernames take the form ('''`username@EXAMPLE.LOCAL`'''). To avoid this being interpreted as an email address, add the Kerberos domain to  ('''`ignore_domains`''').
     21
     22=== Ticket attachment notifications
     23
     24Since 1.0.3 Trac will send notifications when a ticket attachment is added or deleted. Usually attachment notifications will be enabled in an environment by default. To disable the attachment notifications for an environment the `TicketAttachmentNotifier` component must be disabled:
     25{{{#!ini
     26[components]
     27trac.ticket.notification.TicketAttachmentNotifier = disabled
     28}}}
     29
     30== Configuring SMTP Notification
     31
     32'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
     33
     34=== Configuration Options
     35
     36These are the available options for the `[notification]` section in `trac.ini`:
     37
     38[[TracIni(notification)]]
     39
     40=== Example Configuration (SMTP)
     41
     42{{{#!ini
    4443[notification]
    4544smtp_enabled = true
     
    5049}}}
    5150
    52 == Emailサンプル ==
     51=== Example Configuration (`sendmail`)
     52
     53{{{#!ini
     54[notification]
     55smtp_enabled = true
     56email_sender = SendmailEmailSender
     57sendmail_path = /usr/sbin/sendmail
     58smtp_from = notifier@example.com
     59smtp_replyto = myproj@projects.example.com
     60smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     61}}}
     62
     63=== Customizing the e-mail subject
     64
     65The 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:
     66{{{
     67$prefix #$ticket.id: $summary
     68}}}
     69
     70The following variables are available in the template:
     71
     72 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     73 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     74 * `summary`: The ticket summary, with the old value if the summary was edited.
     75 * `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, eg `$ticket.milestone`.
     76
     77=== Customizing the e-mail content
     78
     79The 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:
     80
     81{{{
     82$ticket_body_hdr
     83$ticket_props
     84{% choose ticket.new %}\
     85{%   when True %}\
     86$ticket.description
     87{%   end %}\
     88{%   otherwise %}\
     89{%     if changes_body %}\
     90${_('Changes (by %(author)s):', author=change.author)}
     91
     92$changes_body
     93{%     end %}\
     94{%     if changes_descr %}\
     95{%       if not changes_body and not change.comment and change.author %}\
     96${_('Description changed by %(author)s:', author=change.author)}
     97{%       end %}\
     98$changes_descr
     99--
     100{%     end %}\
     101{%     if change.comment %}\
     102
     103${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     104
     105$change.comment
     106{%     end %}\
     107{%   end %}\
     108{% end %}\
     109
     110--
     111${_('Ticket URL: <%(link)s>', link=ticket.link)}
     112$project.name <${project.url or abs_href()}>
     113$project.descr
     114}}}
     115
     116== Sample Email
     117
    53118{{{
    54119#42: testing
     
    60125    Owner:  anonymous      |    Reporter:  jonas@example.com               
    61126---------------------------+------------------------------------------------
    62 更新 (更新者: jonas@example.com):
    63   * component:  changset view => search system
     127Changes:
     128  * component:  changeset view => search system
    64129  * priority:  low => highest
    65130  * owner:  jonas => anonymous
     
    68133  * status:  new => assigned
    69134
    70 コメント:
     135Comment:
    71136I'm interested too!
    72137
     
    76141}}}
    77142
    78 == トラブルシューティング ==
    79 
    80 通知メールの設定がうまくいかないとき、最初にログが出力されるようになっているか確かめて下さい。そしてどういうエラーメッセージが出力されているかを見てください。[http://trac.edgewall.org/wiki/TracLogging TracLogging] にログについて書いてあるので見て下さい。
    81 
    82 通知メールのエラーは web インタフェースで報告されないので、誰かがチケットを更新したり、新規のチケットを登録しても通知メールが届かないことにまったく気づかないでしょう。 Trac の管理者はエラートレースを追い、ログをみる必要があります。
    83 
    84 === ''Permission denied'' エラー ===
    85 
    86 たいていのエラーメッセージ:
     143== Customizing e-mail content for MS Outlook
     144
     145MS Outlook normally presents plain text e-mails with a variable-width font, and as a result the ticket properties table will most certainly look like a mess in MS Outlook. This can be fixed with some customization of the [#Customizingthee-mailcontent e-mail template].
     146
     147Replace the following second row in the template:
     148{{{
     149$ticket_props
     150}}}
     151
     152with this (requires Python 2.6 or later):
     153{{{
     154--------------------------------------------------------------------------
     155{% with
     156   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     157         [c.strip() for c in
     158          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     159   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     160          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     161${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     162{% end %}\
     163--------------------------------------------------------------------------
     164}}}
     165
     166The table of ticket properties is replaced with a list of a selection of the properties. A tab character separates the name and value in such a way that most people should find this more pleasing than the default table when using MS Outlook.
     167{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     168{{{#!html
     169#42: testing<br />
     170--------------------------------------------------------------------------<br />
     171<table cellpadding=0>
     172<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     173<tr><td>Owner:</td><td>anonymous</td></tr>
     174<tr><td>Type:</td><td>defect</td></tr>
     175<tr><td>Status:</td><td>assigned</td></tr>
     176<tr><td>Priority:</td><td>lowest</td></tr>
     177<tr><td>Milestone:</td><td>0.9</td></tr>
     178<tr><td>Component:</td><td>report system</td></tr>
     179<tr><td>Severity:</td><td>major</td></tr>
     180<tr><td>Resolution:</td><td> </td></tr>
     181<tr><td>Keywords:</td><td> </td></tr>
     182</table>
     183--------------------------------------------------------------------------<br />
     184Changes:<br />
     185<br />
     186&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     187&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     188&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     189&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     191&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     192<br />
     193Comment:<br />
     194I'm interested too!<br />
     195<br />
     196--<br />
     197Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     198My Project &lt;http://myproj.example.com/&gt;<br />
     199}}}
     200}}}
     201
     202**Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which are to be part of the mail, then they have to be added to `sel`. Example:
     203{{{
     204   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     205}}}
     206
     207However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     208
     209== Using GMail as the SMTP relay host
     210
     211Use the following configuration snippet:
     212{{{#!ini
     213[notification]
     214smtp_enabled = true
     215use_tls = true
     216mime_encoding = base64
     217smtp_server = smtp.gmail.com
     218smtp_port = 587
     219smtp_user = user
     220smtp_password = password
     221}}}
     222
     223where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     224
     225Alternatively, you can use `smtp_port = 25`.[[br]]
     226You should not use `smtp_port = 465`. Doing so may deadlock your ticket submission. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [trac:comment:2:ticket:7107 #7107] for details.
     227 
     228== Filtering notifications for one's own changes and comments
     229
     230To delete these notifications in Gmail, use the following filter:
     231{{{
     232from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     233}}}
     234
     235In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
     236
     237You can also add this plugin:
     238http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
     239
     240== Troubleshooting
     241
     242If you cannot get the notification working, first make sure the log is activated and have a look at the log to find if an error message has been logged. See TracLogging for help about the log feature.
     243
     244Notification errors are not reported through the web interface, so the user who submits a change or a new ticket never gets notified about a notification failure. The Trac administrator needs to look at the log to find the error trace.
     245
     246=== ''Permission denied'' error
     247
     248Typical error message:
    87249{{{
    88250  ...
     
    92254}}}
    93255
    94 このエラーはたいていサーバのセキュリティの設定に起因します: 多くの Linux のディストリビューションは web サーバ (Apache など ...) がローカルの SMTP サーバにメールを送信させません。
    95 
    96 多くのユーザは マニュアルに SMTP サーバに接続できるか試すよう書いてあり、成功するので混乱するでしょう:
    97 {{{
     256This error usually comes from a security settings on the server: many Linux distributions do not allow the web server (Apache, ...) to post email messages to the local SMTP server.
     257
     258Many users get confused when their manual attempts to contact the SMTP server succeed:
     259{{{#!sh
    98260telnet localhost 25
    99261}}}
    100 トラブルの原因は、一般ユーザは SMTP サーバに接続できるけれども、 web サーバは接続できないということです:
    101 {{{
     262
     263This is because a regular user may connect to the SMTP server, but the web server cannot:
     264{{{#!sh
    102265sudo -u www-data telnet localhost 25
    103266}}}
    104267
    105 このような場合、 web サーバ が SMTP サーバにメールを送信するときに認証を行うように設定する必要があります。実際の設定は使用している Linux のディストリビューションと現在のセキュリティのポリシーによります。 Trac の [http://trac.edgewall.org/wiki/MailingList MailingList] のアーカイブを参照して下さい。
    106 
    107 関係のあるメーリングリストのスレッド:
    108  * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    109  
    110 === ''Suspected spam'' エラー ===
    111 
    112 SMTP サーバの中には Trac によって送信される通知メールを拒否するのもあるでしょう。
    113 
    114 Trac はデフォルトで通知メールを Base64 エンコーディングして受信者に送信します。メールの本文 (Body) 全体がエンコードされる (訳注:チケットのタイトルに日本語が含まれる場合、通知メールの Subject ヘッダも utf-8 base64 エンコーディングされます) ので、繊細なメールサーバ上の ''false positive'' な SPAM 発見プログラムのトリガになってしまいます。このような状況に遭遇した場合、 `mime_encoding` オプションでデフォルトのエンコーディングを "quoted-printable" に変更することを推奨します。
    115 
    116 "quoted-printable" エンコーディングは ラテン系の文字セットで使用すると効果があります。アジア系の文字セットでは、 Base64 エンコーディングに固定することを推奨します。
    117 
    118 (訳注: 日本語のメールで主に使用されるエンコードは `ISO-2022-JP` ですが、 Trac が送信する通知メールは `UTF-8` でエンコードされ、さらに `BASE64` か `quoted-printable` で 7bit-safe な形式にエンコードされます。
    119 `ISO-2022-JP` エンコーディングでない日本語のメールは Spam 検出エンジンに誤判定されやすくなる傾向があるようです。
    120 また、 MUA がこれらのエンコードに対応していない場合、たとえ受信できたとしても文字化けしたり表示できない可能性があります。)
     268In such a case, you need to configure your server so that the web server is authorized to post to the SMTP server. The actual settings depend on your Linux distribution and current security policy. You may find help in the Trac [trac:MailingList MailingList] archive.
     269
     270Relevant mailing list thread on SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     271
     272For SELinux in Fedora 10:
     273{{{#!sh
     274setsebool -P httpd_can_sendmail 1
     275}}}
     276
     277=== ''Suspected spam'' error
     278
     279Some SMTP servers may reject the notification email sent by Trac.
     280
     281The 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, change the default encoding to "quoted-printable" using the `mime_encoding` option.
     282
     283Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    121284
    122285----
    123 See also: TracTickets, TracIni, TracGuide
     286See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]