Changes between Version 5 and Version 6 of TracNotification


Ignore:
Timestamp:
Jan 28, 2010, 4:25:36 AM (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v5 v6  
    1 = チケット更新情報のメール通知 =
     1= Email Notification of Ticket Changes =
    22[[TracGuideToc]]
    33
    4 Trac はチケット更新情報をメールで通知出来ます。
     4Trac supports notification about ticket changes via email.
    55
    6 メールによる更新通知は、ユーザに関係するチケットについての最新情報を随時に提供したり、専用 ML にチケットの更新情報を配信したりするのに便利な機能です。例えば、 [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] を見るとどのようにセットアップされているか見ることができます。
     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.
    77
    8 通知機能はデフォルトでは無効になっています。有効化とコンフィグレーションは [wiki:TracIni trac.ini] で行うことができます。
     8Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
    99
    10 == メール通知を受け取る ==
    11 新しいチケットを登録したりコメントを追加する際、 ''報告者'' 、 ''担当者'' もしくは ''関係者'' フィールドに有効なメールアドレスを入力してください。チケットに更新があると、 Trac が自動的にメールを送信します。 (どのように通知メール機能を設定しているかによります)
     10== Receiving Notification Mails ==
     11When reporting a new ticket or adding a comment, enter a valid email address 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).
    1212
    13 これは、興味のあるチケットや機能追加に関する最新情報を随時受け取りたい場合に便利な機能です。
     13This is useful to keep up-to-date on an issue or enhancement request that interests you.
    1414
    15 == SMTP 通知のコンフィグレーション ==
     15== Configuring SMTP Notification ==
    1616
    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 文字を含んでいるメールは配信されないでしょう。
     17=== Configuration Options ===
     18These 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.
    3841
    39 '''smtp_from''' か '''smtp_replyto''' の一方 (もしくは両方) が ''必ず'' 設定されていなければなりません。設定されていない場合、 Trac は通知メールの送信を拒否します。
     42Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    4043
    41 === コンフィグレーション例 ===
     44=== Example Configuration ===
    4245
    4346{{{
    … …  
    5053}}}
    5154
    52 == Emailサンプル ==
     55== Sample Email ==
    5356{{{
    5457#42: testing
    … …  
    6063    Owner:  anonymous      |    Reporter:  jonas@example.com               
    6164---------------------------+------------------------------------------------
    62 更新 (更新者: jonas@example.com):
     65Changes:
    6366  * component:  changset view => search system
    6467  * priority:  low => highest
    … …  
    6871  * status:  new => assigned
    6972
    70 コメント:
     73Comment:
    7174I'm interested too!
    7275
    … …  
    7679}}}
    7780
    78 == トラブルシューティング ==
     81== Using GMail as the SMTP relay host ==
    7982
    80 通知メールの設定がうまくいかないとき、最初にログが出力されるようになっているか確かめて下さい。そしてどういうエラーメッセージが出力されているかを見てください。[http://trac.edgewall.org/wiki/TracLogging TracLogging] にログについて書いてあるので見て下さい。
     83Use the following configuration snippet
     84{{{
     85[notification]
     86smtp_enabled = true
     87use_tls = true
     88mime_encoding = base64
     89smtp_server = smtp.gmail.com
     90smtp_port = 587
     91smtp_user = user
     92smtp_password = password
     93}}}
    8194
    82 通知メールのエラーは web インタフェースで報告されないので、誰かがチケットを更新したり、新規のチケットを登録しても通知メールが届かないことにまったく気づかないでしょう。 Trac の管理者はエラートレースを追い、ログをみる必要があります。
     95where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
    8396
    84 === ''Permission denied'' エラー ===
     97Alternatively, you can use `smtp_port = 25`.[[br]]
     98You 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.
     99 
     100== Filtering notifications for one's own changes ==
     101In Gmail, use the filter:
    85102
    86 たいていのエラーメッセージ:
     103{{{
     104from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
     105}}}
     106
     107to delete these notifications.
     108
     109== Troubleshooting ==
     110
     111If 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.
     112
     113Notification errors are not reported through the web interface, so the user who submit 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.
     114
     115=== ''Permission denied'' error ===
     116
     117Typical error message:
    87118{{{
    88119  ...
    … …  
    92123}}}
    93124
    94 このエラーはたいていサーバのセキュリティの設定に起因します: 多くの Linux のディストリビューションは web サーバ (Apache など ...) がローカルの SMTP サーバにメールを送信させません。
     125This error usually comes from a security settings on the server: many Linux distributions do not let the web server (Apache, ...) to post email message to the local SMTP server.
    95126
    96 多くのユーザは マニュアルに SMTP サーバに接続できるか試すよう書いてあり、成功するので混乱するでしょう:
     127Many users get confused when their manual attempts to contact the SMTP server succeed:
    97128{{{
    98129telnet localhost 25
    99130}}}
    100 トラブルの原因は、一般ユーザは SMTP サーバに接続できるけれども、 web サーバは接続できないということです:
     131The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    101132{{{
    102133sudo -u www-data telnet localhost 25
    103134}}}
    104135
    105 このような場合、 web サーバ が SMTP サーバにメールを送信するときに認証を行うように設定する必要があります。実際の設定は使用している Linux のディストリビューションと現在のセキュリティのポリシーによります。 Trac の [http://trac.edgewall.org/wiki/MailingList MailingList] のアーカイブを参照して下さい。
     136In such a case, you need to configure your server so that the web server is authorize to post to the SMTP server. The actual settings depend on your Linux distribution and current security policy. You may find help browsing the Trac MailingList archive.
    106137
    107 関係のあるメーリングリストのスレッド:
     138Relevant ML threads:
    108139 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    109140 
    110 === ''Suspected spam'' エラー ===
     141=== ''Suspected spam'' error ===
    111142
    112 SMTP サーバの中には Trac によって送信される通知メールを拒否するのもあるでしょう。
     143Some SMTP servers may reject the notification email sent by Trac.
    113144
    114 Trac はデフォルトで通知メールを Base64 エンコーディングして受信者に送信します。メールの本文 (Body) 全体がエンコードされる (訳注:チケットのタイトルに日本語が含まれる場合、通知メールの Subject ヘッダも utf-8 base64 エンコーディングされます) ので、繊細なメールサーバ上の ''false positive'' な SPAM 発見プログラムのトリガになってしまいます。このような状況に遭遇した場合、 `mime_encoding` オプションでデフォルトのエンコーディングを "quoted-printable" に変更することを推奨します。
     145The 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, it is recommended to change the default encoding to "quoted-printable" using the `mime_encoding` option.
    115146
    116 "quoted-printable" エンコーディングは ラテン系の文字セットで使用すると効果があります。アジア系の文字セットでは、 Base64 エンコーディングに固定することを推奨します。
    117 
    118 (訳注: 日本語のメールで主に使用されるエンコードは `ISO-2022-JP` ですが、 Trac が送信する通知メールは `UTF-8` でエンコードされ、さらに `BASE64` か `quoted-printable` で 7bit-safe な形式にエンコードされます。
    119 `ISO-2022-JP` エンコーディングでない日本語のメールは Spam 検出エンジンに誤判定されやすくなる傾向があるようです。
    120 また、 MUA がこれらのエンコードに対応していない場合、たとえ受信できたとしても文字化けしたり表示できない可能性があります。)
     147Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended to stick with the Base64 encoding.
    121148
    122149----