XPressME Integration Kit

Trac

Version 1 から Version 2 における更新: TracNotification

差分発生行の前後
Ignore:
Timestamp:
Nov 29, 2010, 3:25:29 PM (13 years 前)
Author:
trac (IP: 127.0.0.1)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v1 v2  
    1 = チケット更新情報のメール通知 = #EmailNotificationofTicketChanges 
     1= Email Notification of Ticket Changes = 
    22[[TracGuideToc]] 
    33 
    4 Trac はチケット更新情報をメールで通知出来ます。 (英語版では Notification) 
    5  
    6 メールによる更新通知は、ユーザに関係するチケットについての最新情報を随時に提供したり、専用 ML にチケットの更新情報を配信したりするのに便利な機能です。例えば、 [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] を見るとどのようにセットアップされているか見ることができます。 
    7  
    8 通知機能はデフォルトでは無効になっています。有効化とコンフィグレーションは [wiki:TracIni trac.ini] で行うことができます。 
    9  
    10 == メール通知を受け取る == #ReceivingNotificationMails 
    11 新しいチケットを登録したりコメントを追加する際、 ''報告者'' (英語版では ''reporter'')、 ''担当者'' (英語版では ''assigned to/owner'') もしくは ''関係者'' (英語版では ''cc'') フィールドに有効なメールアドレスを入力してください。チケットに更新があると、 Trac が自動的にメールを送信します。 (どのように通知メール機能を設定しているかによります) 
    12  
    13 これは、興味のあるチケットや機能追加に関する最新情報を随時受け取りたい場合に便利な機能です。 
    14  
    15 == SMTP 通知のコンフィグレーション == #ConfiguringSMTPNotification 
    16  
    17 === コンフィグレーション オプション === #ConfigurationOptions 
    18 trac.ini の ''[notification]'' セクションで設定できるオプションです。[[BR]](訳注: 0.10 以降では `TracIni` マクロを使用することで正確なオプション一覧を取得できます。以下のリストは必要に応じて `[[TracIni(notification)]]` に置き換えて使用してください。) 
    19  * '''smtp_enabled''': メール通知を有効にします。 
    20  * '''smtp_server''': 通知メッセージに使用されるSMTPサーバ。 
    21  * '''smtp_port''': (''0.9 以降'') SMTP サーバが使用するポート番号。 
    22  * '''smtp_user''': (''0.9 以降'') SMTP認証アカウントのユーザID。 
    23  * '''smtp_password''': (''0.9 以降'') SMTP認証アカウントのパスワード。 
    24  * '''smtp_from''': 通知メールの ''Sender''-ヘッダに使用するメールアドレス。 
    25  * '''smtp_from_name''': 通知メールの ''Sender''-ヘッダに使用する送信者名。 
    26  * '''smtp_replyto''': 通知メールの''Reply-To''-ヘッダに使用するメールアドレス 
    27  * '''smtp_default_domain''': (''0.10 以降'') ドメイン名を含んでいないアドレスに特定のドメイン名を追加します。完全修飾されたアドレスは修正されません。ユーザの設定からメールアドレスが分からないときに、デフォルトドメインをすべてのユーザ名 / ログイン名に追加します。 
    28  * '''smtp_always_cc''': 常に通知メールを送信するメールアドレスのリスト。 ''主に専用MLにチケット更新を通知するのに使用されます。'' 
    29  * '''smtp_always_bcc''': (''0.10 以降'') 常に通知メールを送信するメールアドレスの一覧。ただし、通知メールの他の受信者からメールアドレスが見えません。 
    30  * '''smtp_subject_prefix''': (''0.10.1 以降'') e-mail の subject の前に挿入されるテキスト。デフォルトは "!__default!__" 
    31  * '''always_notify_reporter''': 報告者フィールドのすべてのメールアドレスに常に通知メールを送信します。 (default: false) 
    32  * '''always_notify_owner''': (''0.9 以降'') 担当者フィールドのメールアドレスに常に通知メールを送信します。 (default: false) 
    33  * '''always_notify_updater''': (''0.10 以降'') チケットの更新者に常に通知メールを送信します。 (default: false) 
    34  * '''use_public_cc''': (''0.10 以降'') To: (担当者, 報告者) と CC: のアドレスのリストがすべての受信者に見えるかどうかを設定します ( デフォルトは ''Bcc:'' で見えません) 
    35  * '''use_short_addr''': (''0.10 以降'') 通知メールの配信でメールアドレスがドメイン名を含むようにするかどうかを設定します (例 ''@<domain.com>'' で終わらないようにする)。このオプションは SMTP サーバがローカルアドレスをハンドリングでき、ローカルのメールボックスとユーザ名/ログイン名をマップできるような環境、イントラネット内で使用するときに便利です。 
    36  * '''use_tls''': (''0.10 以降'') SMTP サーバ経由で通知メールを送信するときに、GMail などの [http://en.wikipedia.org/wiki/Transport_Layer_Security TLS] を使用するかどうかを切り替えます。 
    37  * '''mime_encoding''': (''0.10 以降'') 通知メールは常に 7-bit モードで送信されます。このオプションで MIME エンコードの選択ができます。利用可能な値は以下の通りです: 
    38    * `base64`: デフォルトの値です。どのような種類の内容にも対応できます。 デリケートな アンチスパム / アンチウイルス エンジンにひっかかるかもしれません。 
    39    * `qp` または `quoted-printable`: ヨーロッパの言語に適しています。 (base64 よりコンパクトです) non-ASCII テキストには推奨できません。 (base64 のほうがコンパクトになります ) 
    40    * `none`: エンコードしません。英語のみ (ASCII) で使用できます。 non-ASCII 文字を含んでいるメールは配信されないでしょう。 
    41  
    42 '''smtp_from''' か '''smtp_replyto''' の一方 (もしくは両方) が ''必ず'' 設定されていなければなりません。設定されていない場合、 Trac は通知メールの送信を拒否します。 
    43  
    44 === コンフィグレーションの例 === #ExampleConfiguration 
    45  
     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 == 
     11When reporting a new ticket or adding a comment, enter a valid email address or your 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). 
     12 
     13This is useful to keep up-to-date on an issue or enhancement request that interests you. 
     14 
     15=== How to use your username to receive notification mails === 
     16 
     17To receive notification mails, you can either enter a full email address or your username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page.  
     18 
     19Alternatively, 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. 
     20 
     21== Configuring SMTP Notification == 
     22 
     23'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].  
     24 
     25=== Configuration Options === 
     26These are the available options for the `[notification]` section in trac.ini. 
     27 
     28 * '''`smtp_enabled`''': Enable email notification. 
     29 * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails. 
     30 * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails. 
     31 * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails. 
     32 * '''`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. 
     33 * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' 
     34 * '''`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  
     35 * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default. 
     36 * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false). 
     37 * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false). 
     38 * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true). 
     39 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). 
     40 * '''`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.  
     41 * '''`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: 
     42   * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. 
     43   * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64) 
     44   * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.  
     45 * '''`ticket_subject_template`''': (''since 0.11'') A [http://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet used to get the notification subject. 
     46 * '''`email_sender`''': (''since 0.12'') Name of the component implementing `IEmailSender`. This component is used by the notification system to send emails. Trac currently provides the following components: 
     47   * `SmtpEmailSender`: connects to an SMTP server (default). 
     48   * `SendmailEmailSender`: runs a `sendmail`-compatible executable. 
     49 
     50Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
     51 
     52The following options are specific to email delivery through SMTP. 
     53 * '''`smtp_server`''': SMTP server used for notification messages. 
     54 * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server. 
     55 * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account. 
     56 * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account. 
     57 * '''`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. 
     58 
     59The following option is specific to email delivery through a `sendmail`-compatible executable. 
     60 * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options. 
     61 
     62=== Example Configuration (SMTP) === 
    4663{{{ 
    4764[notification] 
     
    5370}}} 
    5471 
    55 == Email サンプル == #SampleEmail 
     72=== Example Configuration (`sendmail`) === 
     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}}} 
     82 
     83=== Customizing the e-mail subject === 
     84The 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: 
     85{{{ 
     86$prefix #$ticket.id: $summary 
     87}}} 
     88The following variables are available in the template: 
     89 
     90 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]). 
     91 * `prefix`: The prefix defined in `smtp_subject_prefix`. 
     92 * `summary`: The ticket summary, with the old value if the summary was edited. 
     93 * `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`. 
     94 
     95=== Customizing the e-mail content === 
     96 
     97The 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: 
     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}}} 
     133== Sample Email == 
    56134{{{ 
    57135#42: testing 
     
    79157}}} 
    80158 
    81 == SMTP リレーホストとして GMail を使用する == #UsingGMailastheSMTPrelayhost 
    82  
    83 以下のような設定を使用します 
     159== Using GMail as the SMTP relay host == 
     160 
     161Use the following configuration snippet 
    84162{{{ 
    85163[notification] 
     
    93171}}} 
    94172 
    95 ''user'' と ''password'' の箇所は、 GMail のアカウントで置き換えてください。 ''たとえば'' [http://gmail.com] にログインするときに使用しているものです。 
    96  
    97 代わりに `smtp_port = 25` を使用することもできます。 (訳注: おそらく `gmail.com` 宛のメールしか届きません)[[br]] 
    98 しかし `smtp_port = 465` は使用できません。これは動作しないだけでなく、通知メール送信がデッドロックします。ポート番号 465 は SMTPS プロトコル (訳注: SSMTP とも言います) に使用されますが、 Trac はこれをサポートしていません。詳しくは [http://trac.edgewall.org/ticket/7107#comment:2 #7107] を参照してください。 
     173where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com] 
     174 
     175Alternatively, you can use `smtp_port = 25`.[[br]] 
     176You 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. 
    99177  
    100 == 自分が変更した通知をフィルタする == #Filteringnotificationsforonesownchanges 
    101 Gmail では、以下のフィルタを使用できます: 
     178== Filtering notifications for one's own changes == 
     179In Gmail, use the filter: 
    102180 
    103181{{{ 
     
    105183}}} 
    106184 
    107 通知メールを削除する場合などに使用してください。 
    108  
    109 == トラブルシューティング == #Troubleshooting 
    110  
    111 通知メールの設定がうまくいかないとき、最初にログが出力されるようになっているか確かめて下さい。そしてどういうエラーメッセージが出力されているかを見てください。[http://trac.edgewall.org/wiki/TracLogging TracLogging] にログについて書いてあるので見て下さい。 
    112  
    113 通知メールのエラーは Web インタフェースで報告されないので、誰かがチケットを更新したり、新規のチケットを登録しても通知メールが届かないことにまったく気づかないでしょう。 Trac の管理者はエラートレースを追い、ログをみる必要があります。 
    114  
    115 === ''Permission denied'' エラー === #Permissiondeniederror 
    116  
    117 たいていのエラーメッセージ: 
     185For Trac .10, use the filter: 
     186{{{ 
     187from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)") 
     188}}} 
     189 
     190to delete these notifications. 
     191 
     192In Thunderbird, there is no such solution if you use IMAP 
     193(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body). 
     194 
     195The best you can do is to set "always_notify_updater" in conf/trac.ini to false. 
     196You will however still get an email if you comment a ticket that you own or have reported. 
     197 
     198You can also add this plugin: 
     199http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin 
     200 
     201== Troubleshooting == 
     202 
     203If 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. 
     204 
     205Notification 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. 
     206 
     207=== ''Permission denied'' error === 
     208 
     209Typical error message: 
    118210{{{ 
    119211  ... 
     
    123215}}} 
    124216 
    125 このエラーはたいていサーバのセキュリティの設定に起因します: 多くの Linux のディストリビューションでは Web サーバ (Apache など ...) からローカルの SMTP サーバにメールを送信させません。 
    126  
    127 多くのユーザはマニュアルに SMTP サーバに接続できるか試すよう書いてあり、成功するので混乱するでしょう: 
     217This 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. 
     218 
     219Many users get confused when their manual attempts to contact the SMTP server succeed: 
    128220{{{ 
    129221telnet localhost 25 
    130222}}} 
    131 トラブルの原因は、一般ユーザは SMTP サーバに接続できるけれども、 Web サーバは接続できないということです: 
     223The trouble is that a regular user may connect to the SMTP server, but the web server cannot: 
    132224{{{ 
    133225sudo -u www-data telnet localhost 25 
    134226}}} 
    135227 
    136 このような場合、 Web サーバ が SMTP サーバにメールを送信するときに認証を行うように設定する必要があります。実際の設定は使用している Linux のディストリビューションと現在のセキュリティのポリシーによります。 Trac の [http://trac.edgewall.org/wiki/MailingList MailingList] のアーカイブを参照して下さい。 
    137  
    138 関係のあるメーリングリストのスレッド: 
     228In 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 browsing the Trac [trac:MailingList MailingList] archive. 
     229 
     230Relevant ML threads: 
    139231 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 
    140   
    141 === ''Suspected spam'' エラー === #Suspectedspamerror 
    142  
    143 SMTP サーバの中には Trac によって送信される通知メールを拒否するのもあるでしょう。 
    144  
    145 Trac はデフォルトで通知メールを Base64 エンコーディングして受信者に送信します。メールの本文 (Body) 全体がエンコードされる (訳注:チケットのタイトルに日本語が含まれる場合、通知メールの Subject ヘッダも utf-8 base64 エンコーディングされます) ので、繊細なメールサーバ上の ''false positive'' な SPAM 発見プログラムのトリガになってしまいます。このような状況に遭遇した場合、 `mime_encoding` オプションでデフォルトのエンコーディングを "quoted-printable" に変更することを推奨します。 
    146  
    147 "quoted-printable" エンコーディングは ラテン系の文字セットで使用すると効果があります。アジア系の文字セットでは、 Base64 エンコーディングに固定することを推奨します。 
    148  
    149 (訳注: 日本語のメールで主に使用されるエンコードは `ISO-2022-JP` ですが、 Trac が送信する通知メールは `UTF-8` でエンコードされ、さらに `BASE64` か `quoted-printable` で 7bit-safe な形式にエンコードされます。 
    150 `ISO-2022-JP` エンコーディングでない日本語のメールは Spam 検出エンジンに誤判定されやすくなる傾向があるようです。 
    151 また、 MUA がこれらのエンコードに対応していない場合、たとえ受信できたとしても文字化けしたり表示できない可能性があります。) 
     232 
     233For SELinux in Fedora 10: 
     234{{{ 
     235$ setsebool -P httpd_can_sendmail 1 
     236}}} 
     237=== ''Suspected spam'' error === 
     238 
     239Some SMTP servers may reject the notification email sent by Trac. 
     240 
     241The 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. 
     242 
     243Quoted 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. 
     244 
     245=== ''501, 5.5.4 Invalid Address'' error === 
     246 
     247On IIS 6.0 you could get a  
     248{{{ 
     249Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address') 
     250}}} 
     251in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it. 
     252 
    152253 
    153254----