wiki:TracNotification

Version 5 (modified by trac, 11 years ago) (diff)

--

チケット更新情報のメール通知

Trac はチケット更新情報をメールで通知出来ます。

メールによる更新通知は、ユーザに関係するチケットについての最新情報を随時に提供したり、専用 ML にチケットの更新情報を配信したりするのに便利な機能です。例えば、 Trac-tickets を見るとどのようにセットアップされているか見ることができます。

通知機能はデフォルトでは無効になっています。有効化とコンフィグレーションは trac.ini で行うことができます。

メール通知を受け取る

新しいチケットを登録したりコメントを追加する際、 報告者担当者 もしくは 関係者 フィールドに有効なメールアドレスを入力してください。チケットに更新があると、 Trac が自動的にメールを送信します。 (どのように通知メール機能を設定しているかによります)

これは、興味のあるチケットや機能追加に関する最新情報を随時受け取りたい場合に便利な機能です。

SMTP 通知のコンフィグレーション

コンフィグレーション オプション

trac.ini の [notification] セクションで設定できるオプションです。
(訳注: 0.10 以降では TracIni マクロを使用することで正確なオプション一覧を取得できます。以下のリストは必要に応じて [[TracIni(notification)]] に置き換えて使用してください。)

  • smtp_enabled: メール通知を有効にします。
  • smtp_server: 通知メッセージに使用されるSMTPサーバ。
  • smtp_user: (0.9 以降) SMTP認証アカウントのユーザID。
  • smtp_password: (0.9 以降) SMTP認証アカウントのパスワード。
  • smtp_from: 通知メールのSender-ヘッダに使用するメールアドレス。
  • smtp_replyto: 通知メールのReply-To-ヘッダに使用するメールアドレス
  • smtp_default_domain: (0.10 以降) ドメイン名を含んでいないアドレスに特定のドメイン名を追加します。完全修飾されたアドレスは修正されません。ユーザの設定からメールアドレスが分からないときに、デフォルトドメインをすべてのユーザ名 / ログイン名に追加します。
  • smtp_always_cc: 常に通知メールを送信するメールアドレスのリスト。 主に専用MLにチケット更新を通知するのに使用されます。
  • smtp_always_bcc: (0.10 以降) 常に通知メールを送信するメールアドレスの一覧。ただし、通知メールの他の受信者からメールアドレスが見えません。
  • always_notify_reporter: 報告者フィールドのすべてのメールアドレスに常に通知メールを送信します。
  • always_notify_owner: (0.9 以降) 担当者フィールドのメールアドレスに常に通知メールを送信します。
  • always_notify_updater: (0.10 以降) チケットの更新者に常に通知メールを送信します。
  • use_public_cc: (0.10 以降) To: (担当者, 報告者) と CC: のアドレスのリストがすべての受信者に見えるかどうかを設定します ( デフォルトは Bcc: で見えません)
  • use_short_addr: (0.10 以降) 通知メールの配信でメールアドレスがドメイン名を含むようにするかどうかを設定します (例 @<domain.com> で終わらないようにする)。このオプションは SMTP サーバがローカルアドレスをハンドリングでき、ローカルのメールボックスとユーザ名/ログイン名をマップできるような環境、イントラネット内で使用するときに便利です。
  • mime_encoding: (0.10 以降) 通知メールは常に 7-bit モードで送信されます。このオプションで MIME エンコードの選択ができます。利用可能な値は以下の通りです:
    • base64: デフォルトの値です。どのような種類の内容にも対応できます。 デリケートな アンチスパム / アンチウイルス エンジンにひっかかるかもしれません。
    • qp または quoted-printable: ヨーロッパの言語に適しています。 (base64 よりコンパクトです) non-ASCII テキストには推奨できません。 (base64 のほうがコンパクトになります )
    • none: エンコードしません。英語のみ (ASCII) で使用できます。 non-ASCII 文字を含んでいるメールは配信されないでしょう。

smtp_fromsmtp_replyto の一方 (もしくは両方) が 必ず 設定されていなければなりません。設定されていない場合、 Trac は通知メールの送信を拒否します。

コンフィグレーション例

[notification]
smtp_enabled = true
smtp_server = mail.example.com
smtp_from = notifier@example.com
smtp_replyto = myproj@projects.example.com
smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com

Emailサンプル

#42: testing
---------------------------+------------------------------------------------
       Id:  42             |      Status:  assigned                
Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
 Severity:  major          |   Milestone:  0.9                     
 Priority:  lowest         |     Version:  0.6                     
    Owner:  anonymous      |    Reporter:  jonas@example.com               
---------------------------+------------------------------------------------
更新 (更新者: jonas@example.com):
  * component:  changset view => search system
  * priority:  low => highest
  * owner:  jonas => anonymous
  * cc:  daniel@example.com =>
         daniel@example.com, jonas@example.com
  * status:  new => assigned

コメント:
I'm interested too!

--
Ticket URL: <http://example.com/trac/ticket/42>
My Project <http://myproj.example.com/>

トラブルシューティング

通知メールの設定がうまくいかないとき、最初にログが出力されるようになっているか確かめて下さい。そしてどういうエラーメッセージが出力されているかを見てください。TracLogging にログについて書いてあるので見て下さい。

通知メールのエラーは web インタフェースで報告されないので、誰かがチケットを更新したり、新規のチケットを登録しても通知メールが届かないことにまったく気づかないでしょう。 Trac の管理者はエラートレースを追い、ログをみる必要があります。

Permission denied エラー

たいていのエラーメッセージ:

  ...
  File ".../smtplib.py", line 303, in connect
    raise socket.error, msg
  error: (13, 'Permission denied')

このエラーはたいていサーバのセキュリティの設定に起因します: 多くの Linux のディストリビューションは web サーバ (Apache など ...) がローカルの SMTP サーバにメールを送信させません。

多くのユーザは マニュアルに SMTP サーバに接続できるか試すよう書いてあり、成功するので混乱するでしょう:

telnet localhost 25

トラブルの原因は、一般ユーザは SMTP サーバに接続できるけれども、 web サーバは接続できないということです:

sudo -u www-data telnet localhost 25

このような場合、 web サーバ が SMTP サーバにメールを送信するときに認証を行うように設定する必要があります。実際の設定は使用している Linux のディストリビューションと現在のセキュリティのポリシーによります。 Trac の MailingList のアーカイブを参照して下さい。

関係のあるメーリングリストのスレッド:

Suspected spam エラー

SMTP サーバの中には Trac によって送信される通知メールを拒否するのもあるでしょう。

Trac はデフォルトで通知メールを Base64 エンコーディングして受信者に送信します。メールの本文 (Body) 全体がエンコードされる (訳注:チケットのタイトルに日本語が含まれる場合、通知メールの Subject ヘッダも utf-8 base64 エンコーディングされます) ので、繊細なメールサーバ上の false positive な SPAM 発見プログラムのトリガになってしまいます。このような状況に遭遇した場合、 mime_encoding オプションでデフォルトのエンコーディングを "quoted-printable" に変更することを推奨します。

"quoted-printable" エンコーディングは ラテン系の文字セットで使用すると効果があります。アジア系の文字セットでは、 Base64 エンコーディングに固定することを推奨します。

(訳注: 日本語のメールで主に使用されるエンコードは ISO-2022-JP ですが、 Trac が送信する通知メールは UTF-8 でエンコードされ、さらに BASE64quoted-printable で 7bit-safe な形式にエンコードされます。 ISO-2022-JP エンコーディングでない日本語のメールは Spam 検出エンジンに誤判定されやすくなる傾向があるようです。 また、 MUA がこれらのエンコードに対応していない場合、たとえ受信できたとしても文字化けしたり表示できない可能性があります。)


See also: TracTickets, TracIni, TracGuide