Changes between Version 2 and Version 3 of TracNotification


Ignore:
Timestamp:
2012/06/16 22:07:38 (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v2 v3  
    88通知機能はデフォルトでは無効になっています。有効化とコンフィグレーションは [wiki:TracIni trac.ini] で行うことができます。 
    99 
    10 == メール通知を受け取る == #ReceivingNotificationMails 
    11 新しいチケットを登録したりコメントを追加する際、 ''報告者'' (英語版では ''reporter'')、 ''担当者'' (英語版では ''assigned to/owner'') もしくは ''関係者'' (英語版では ''cc'') フィールドに有効なメールアドレスを入力してください。チケットに更新があると、 Trac が自動的にメールを送信します。 (どのように通知メール機能を設定しているかによります) 
     10== 通知メールを受け取る == #ReceivingNotificationMails 
     11新しいチケットを登録したりコメントを追加する際、 ''報告者'' (英語版では ''reporter'')、 ''担当者'' (英語版では ''assigned to/owner'') もしくは ''関係者'' (英語版では ''cc'') フィールドに有効なメールアドレスやユーザ名を入力してください。チケットに更新があると、 Trac が自動的にメールを送信します。 (どのように通知メール機能を設定しているかによります) 
    1212 
    1313これは、興味のあるチケットや機能追加に関する最新情報を随時受け取りたい場合に便利な機能です。 
    1414 
     15=== 通知メールで受信するメールアドレスを設定する方法 === #Howtouseyourusernametoreceivenotificationmails 
     16 
     17完全なメールアドレスあるいはユーザー名を入力することで、通知メールを受け取ることができます。 単純なユーザ名やログイン名で通知を受け取るには、''ユーザ設定 (Preferences)'' ページで、正しいメールアドレスを入力する必要があります。 
     18 
     19TracIni ファイルにデフォルトドメイン名 ('''`smtp_default_domain`''') を指定することでも、単純なユーザ名で通知を受け取ることができるようになります。 (後述する [#ConfigurationOptions コンフィグレーション オプション] を参照してください) 。この場合、ユーザ名にデフォルトドメインが追加されますので、 "イントラネット" 環境で仕様している場合は便利です。 
     20 
    1521== SMTP 通知のコンフィグレーション == #ConfiguringSMTPNotification 
     22 
     23'''重要:''' TracNotification を正しく動作させるには、[wiki:TracIni trac.ini] に `[trac] base_url` を設定する必要があります。 
    1624 
    1725=== コンフィグレーション オプション === #ConfigurationOptions 
    1826trac.ini の `[notification]` セクションで設定できるオプションです。[[BR]](訳注: 0.10 以降では `TracIni` マクロを使用することで正確なオプション一覧を取得できます。以下のリストは必要に応じて `[[TracIni(notification)]]` に置き換えて使用してください。) 
     27 
    1928 * '''`smtp_enabled`''': メール通知を有効にします。 
    2029 * '''`smtp_from`''': 通知メールの ''Sender''-ヘッダに使用するメールアドレス。 
     
    3039 * '''`use_public_cc`''': (''0.10 以降'') To: (担当者, 報告者) と CC: のアドレスのリストがすべての受信者に見えるかどうかを設定します ( デフォルトは ''Bcc:'' で見えません) 
    3140 * '''`use_short_addr`''': (''0.10 以降'') 通知メールの配信でメールアドレスがドメイン名を含むようにするかどうかを設定します (例 ''@<domain.com>'' で終わらないようにする)。このオプションは SMTP サーバがローカルアドレスをハンドリングでき、ローカルのメールボックスとユーザ名/ログイン名をマップできるような環境、イントラネット内で使用するときに便利です。 
    32  * '''`mime_encoding`''': (''0.10 以降'') 通知メールは常に 7-bit モードで送信されます。このオプションで MIME エンコードの選択ができます。利用可能な値は以下の通りです: 
    33    * `base64`: デフォルトの値です。どのような種類の内容にも対応できます。 デリケートな アンチスパム / アンチウイルス エンジンにひっかかるかもしれません 
    34    * `qp` または `quoted-printable`: ヨーロッパの言語に適しています。 (base64 よりコンパクトです) non-ASCII テキストには推奨できません。 (base64 のほうがコンパクトになります ) 
    35    * `none`: エンコードしません。英語のみ (ASCII) で使用できます。 non-ASCII 文字を含んでいるメールは配信されないでしょう 
     41 * '''`mime_encoding`''': (''0.10 以降'') MIME のエンコードのスキームを選択します。サポートする値: 
     42   * `none`: デフォルト値。テキストがプレーンな ASCII 文字コード、もしくはその他 8 ビットの文字コードであるときに、 7 ビットエンコードを使用します 
     43   * `base64`: どのような内容が含まれていても動作します。敏感なアンチスパム / アンチウイルスエンジンではいくつかの問題があるかもしれません。 
     44   * `qp` または `quoted-printable`: 8 ビットエンコーディングが使用できない場合、ヨーロッパの言語に対して最適です ( base64 よりもコンパクトです ) 
    3645 * '''`ticket_subject_template`''': (''0.11 以降'') 通知メールの件名 (Subject) に使用する [http://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi テキストテンプレート] 。 
     46 * '''`email_sender`''': (''0.12 以降'') `IEmailSender` インタフェースを実装しているコンポーネント名。通知システムは、ここで設定されたコンポーネントを使用してメールを送信します。現在のところ Trac では以下のコンポーネントが提供されています: 
     47   * `SmtpEmailSender`: SMTP サーバに接続してメールを送信する (デフォルト)。 
     48   * `SendmailEmailSender`: `sendmail` 互換の実行ファイルを実行してメールを送信する。 
    3749 
    3850'''`smtp_from`''' か '''`smtp_replyto`''' の一方 (もしくは両方) が ''必ず'' 設定されていなければなりません。設定されていない場合、 Trac は通知メールの送信を拒否します。 
     
    4153 * '''`smtp_server`''': 通知メッセージに使用されるSMTPサーバ。 
    4254 * '''`smtp_port`''': (''0.9 以降'') SMTP サーバが使用するポート番号。 
    43  * '''`smtp_user`''': (''0.9 以降'') SMTP認証アカウントのユーザID。 
    44  * '''`smtp_password`''': (''0.9 以降'') SMTP認証アカウントのパスワード。 
     55 * '''`smtp_user`''': (''0.9 以降'') SMTP 認証アカウントのユーザID。 
     56 * '''`smtp_password`''': (''0.9 以降'') SMTP 認証アカウントのパスワード。 
    4557 * '''`use_tls`''': (''0.10 以降'') SMTP サーバ経由で通知メールを送信するときに、GMail などの [http://en.wikipedia.org/wiki/Transport_Layer_Security TLS] を使用するかどうかを切り替えます。 
    4658 
     59以下のオプションは `sendmail` 互換の実行ファイルを使用する場合のメッセージ伝送方法を指定するために使用します。 
     60 * '''`sendmail_path`''': (''0.12 以降'') sendmail の実行ファイルへのパスを設定します。ここで指定する sendmail プログラムは `-i` および `-f` オプションを解釈できなければなりません。 
    4761 
    4862=== コンフィグレーションの例 (SMTP) === #ExampleConfigurationSMTP 
     
    5670}}} 
    5771 
     72=== コンフィグレーションの例 (`sendmail`) === #ExampleConfigurationsendmail 
     73{{{ 
     74[notification] 
     75smtp_enabled = true 
     76email_sender = SendmailEmailSender 
     77sendmail_path = /usr/sbin/sendmail 
     78smtp_from = notifier@example.com 
     79smtp_replyto = myproj@projects.example.com 
     80smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com 
     81}}} 
    5882 
    5983=== メールの件名をカスタマイズする === #Customizingthee-mailsubject 
     
    6993 * `ticket`: ticket model オブジェクト ([http://trac.edgewall.org/browser/trunk/trac/ticket/model.py model.py] 参照)。個別のチケット属性は `$ticket.milestone` のように、ドット (.) で区切って (訳注: 英語での) 属性名を加えることで、参照可能。 
    7094 
     95=== メールの内容をカスタマイズする === #Customizingthee-mailcontent 
     96 
     97通知メールの内容は `trac/ticket/templates` の `ticket_notify_email.txt` を元に生成されます。編集した `ticket_notify_email.txt` を Environment の templates ディレクトリに配置することで、カスタマイズすることができます。デフォルトはこのようになっています: 
     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 
     108Changes (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 
     114Description changed by $change.author: 
     115      #end 
     116$changes_descr 
     117-- 
     118    #end 
     119    #if change.comment 
     120 
     121Comment${not changes_body and '(by %s)' % change.author or ''}: 
     122 
     123$change.comment 
     124    #end 
     125  #end 
     126#end 
     127 
     128--  
     129Ticket URL: <$ticket.link> 
     130$project.name <${project.url or abs_href()}> 
     131$project.descr 
     132}}} 
    71133== Email サンプル == #SampleEmail 
    72134{{{ 
     
    121183}}} 
    122184 
    123 通知メールを削除する場合などに使用してください。 
     185Trac 0.10 の場合は、下記のフィルタを使用してください: 
     186{{{ 
     187from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)") 
     188}}} 
     189 
     190通知メールを削除する場合などにも使用できます。 
    124191 
    125192Thunderbird で IMAP を使用している場合は、この方法は使えません 
     
    163230関係のあるメーリングリストのスレッド: 
    164231 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 
    165   
     232 
     233Fedora 10 の SELinux では下記のコマンドで対処できます: 
     234{{{ 
     235$ setsebool -P httpd_can_sendmail 1 
     236}}} 
    166237=== ''Suspected spam'' エラー === #Suspectedspamerror 
    167238 
     
    170241Trac はデフォルトで通知メールを Base64 エンコーディングして受信者に送信します。メールの本文 (Body) 全体がエンコードされる (訳注:チケットのタイトルに日本語が含まれる場合、通知メールの Subject ヘッダも utf-8 base64 エンコーディングされます) ので、繊細なメールサーバ上の ''false positive'' な SPAM 発見プログラムのトリガになってしまいます。このような状況に遭遇した場合、 `mime_encoding` オプションでデフォルトのエンコーディングを "quoted-printable" に変更することを推奨します。 
    171242 
    172 "quoted-printable" エンコーディングは ラテン系の文字セットで使用すると効果があります。アジア系の文字セットでは、 Base64 エンコーディングに固定することを推奨します。 
    173  
    174 (訳注: 日本語のメールで主に使用されるエンコードは `ISO-2022-JP` ですが、 Trac が送信する通知メールは `UTF-8` でエンコードされ、さらに `BASE64` か `quoted-printable` で 7bit-safe な形式にエンコードされます。 
    175 `ISO-2022-JP` エンコーディングでない日本語のメールは Spam 検出エンジンに誤判定されやすくなる傾向があるようです。 
    176 また、 MUA がこれらのエンコードに対応していない場合、たとえ受信できたとしても文字化けしたり表示できない可能性があります。) 
     243"quoted-printable" エンコーディングは ラテン系の文字セットで使用すると効果があります。アジア系の文字セットでは、 Base64 エンコーディングに固定することを推奨します。 (訳注: 日本語のメールで主に使用されるエンコードは `ISO-2022-JP` ですが、 Trac が送信する通知メールは `UTF-8` でエンコードされ、さらに `BASE64` か `quoted-printable` で 7bit-safe な形式にエンコードされます。 `ISO-2022-JP` エンコーディングでない日本語のメールは Spam 検出エンジンに誤判定されやすくなる傾向があるようです。また、 MUA がこれらのエンコードに対応していない場合、たとえ受信できたとしても文字化けしたり表示できない可能性があります。) 
     244 
     245=== ''501, 5.5.4 Invalid Address'' エラー === #a5015.5.4InvalidAddresserror 
     246 
     247IIS 6.0 で 
     248{{{ 
     249Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address') 
     250}}} 
     251上記のエラーが trac のログにでる場合、 [http://support.microsoft.com/kb/291828 ここ]を参考に解決してください。 
     252 
    177253 
    178254----