Warning: リポジトリと同期できません (サポートされていないバージョンコントロールシステム "svn です。 Python のライブラリに "svn" が正しくインストールされているか確認してください。)

バージョン 4 から バージョン 5 における更新: TracDoc/MailArchivePlugin

差分発生行の前後
無視リスト:
更新日時:
2006/04/22 15:29:37 (18 年 前)
更新者:
weekbuild (IP アドレス: 59.147.202.119)
コメント:

--

凡例:

変更なし
追加
削除
変更
  • TracDoc/MailArchivePlugin

    v4 v5  
    11{{{ 
    22#!trachtml 
    3 <h1 id="!MailArchivePlugin">!MailArchivePlugin</h1>    <h2 id="1. 概要">1. 概要</h2>      <p>MLなどのメールを保管し、Tracにて表示・検索するためのプラグインです。  <br /> プロジェクトですでに使用しているMLがあり、その内容をTracで一元管理したい場合にお使いください。<br /> <span class="wiki">([http://trac-hacks.org/wiki/EmailtoTracScript EmailtoTracScript]                              </span>の様に、メールをチケットに投入する機能はありません。)<br /> </p>   <p>Tracの強力なリンク機能を利用できます。たとえば、Wikiで特定のメールを示すリンクを作成したり、メールの本文に書かれたチケットの番号をリンクにしてしまうことが可能です。また、検索やタイムラインといったTracの基本機能にも対応しています。<br /> <br />      </p>    <h2 id="2. 主な機能">2. 主な機能</h2>    <ul> <li>メールのインポート<br /> unixmail形式のメールのインポートします。添付ファイルはTracのAttachementとして管理します。<br />     <br /> </li><li>メールサーバからのメール受信<br /> pop3でサーバから直接メールを受信可能です。<br /> <br />   </li><li>読み込んだメールのスレッドツリー表示<br /> ML名ごと・月ごとにメールをスレッド表示します。<br />     [[Image(MailArc001mini.png)]]<br /> <br /> </li><li>メール本文のWiki表示<br /> メール本文にTracのwiki構文で解釈し、リンクに変換します。 たとえばメール本文内に<em>!#1</em>という文字があれば、チケットの!#1へのリンクに変換します。<br />     [[Image(MailArc005mini.png)]]<br />   </li> </ul>   <ul> <li>メールの検索<br /> Tracの検索機能で、メールのサブジェクトと本文を検索可能です。<br />     [[Image(MailArc003mini.png)]]<br /> <br /> </li><li>メールのタイムライン表示<br /> Tracのタイムライン機能で、メールの送信日をもとにタイムラインとして表示可能です。<br /> チケットの登録やリポジトリのコミットと、メールの送信日をいっしょに表示することが出来ます。<br />     [[Image(MailArc004mini.png)]]<br /> <br />  </li><li>Wikiでリンク指定<br /> Tracの強力なリンク機能をメールにも適用します。Wikiにメール単体をさすリンクを指定可能です。Message-IDや、MLで良く使われるサブジェクト([aaa:001],[aaa 001]など)を リンクにします。<br />     <br /> </li> </ul>    <h2 id="3. セットアップ">3. セットアップ</h2>   <h3 id="3.1 ダウンロード">3.1 ダウンロード</h3>  以下からダウンロードしてください。<br />  ・!MailArchivePlugin Version 0.1<br />   <h3 id="3.2 インストール">3.2 インストール</h3>  MailArchivePluginのインストールを行います。[[FootNote(Tracのプラグインに共通する説明は、[wiki:TracPlugins TracPlugins]を参照してください。)]]<br />        <h4 id="(1) eggの設置 ">(1) eggの設置 </h4>       <p>zipを解凍してください。<br /> 解凍して出来たフォルダ配下のsrcディレクトリに移動してください。<br /> 以下のコマンドを実行して下さい:  </p>     <pre class="wiki">$ python setup.py bdist_egg<br /></pre>      <p> distフォルダが作成されます。<br /> その中にある*.eggファイルを、TracEnvのplugins ディレクトリにコピーしてください。<br /> </p>     <h4 id="(2) TracEnvのupgrade">(2) TracEnvのupgrade</h4>  DBにMailArchivePlugin用のテーブルを追加するために、TracEnvをupgradeする必要があります。以下のコマンドを実行してください。<br />   <pre>$ trac-admin [TracEnvのディレクトリ] upgrade<br /></pre>   <h4 id="(3) Trac.iniの設定">(3) Trac.iniの設定</h4>  MailArchivePluginを使用可能にするには、Trac.iniの[components]カテゴリに以下を加えてください。<br />  (pluginフォルダに置いた場合には不要)<br />     <pre>[componets]<br />mailarchiveplugin.* = enabled<br /></pre>  ここまでで、MailArchivePluginのインストールは終了です。メインメニューに「メール倉庫」というメニューが追加されていると思います。<br />    ただし、まだメールをインポートしてないので、メニューを押しても何も表示されません。<br />    引き続き、メールをインポートするための設定と、メールのインポートを行ってください。<br />  <br />     <h2 id="4. メールのインポート">4. メールのインポート</h2>   <h3 id="4.1 説明">4.1 説明</h3>    <p>MailArchivePluginでメールを表示・検索するには、まずメールデータをTracに取込む(=インポートする)必要があります。<br />  </p>  メー ルをインポートするには、2通りの方法があります。unixmail形式のメールファイルのインポートと、pop3サーバからのメールの受信です。「片方 の方法だけ使う」ことも可能ですし、「最初に今までのメールをインポートしてから、今後はpop3でメールを受信する。」というような使い方をも可能で す。<br />        <blockquote><strong>注意:</strong><br />   <ul><li>メールのデータはTracEnvのデータベースに保存します。ディスク使用量に注意してください。大抵はメールのほうがTracに蓄積されたデータよりも大きいので。。</li><li>メー ルの添付ファイルはTracのAttachmentとして保存します。Trac.iniに記載されたサイズより大きな添付ファイルは取り込み出来ません。 Trac.iniの[attachment]のmax_size(デフォルトは262,144Byte)を大きくしたほうがよいでしょう。</li><li>HTML形式のメールは取り込み出来ません。</li><li>マ ルイチなどの記号文字は取り込み出来ない可能性が高いです。これは日本でのメールの標準的な文字コードがJISであるところか らくる仕様です。(どうしても取り込みたければ、コーデックを開発してTrac.iniの[mailarchive]のcodecaliasに設定してく ださい。)</li><li>メールデータのユニークキーはMessage-IDです。すでにDBに同じMessage-IDのメールがDBに存在する場合は、新しく取込んだメールで上書きします。<br />     </li></ul> </blockquote>              <h3 id="4.2 設定 ">4.2 設定 </h3>    Trac.iniの以下の項目を設定してください。 <br />  <br /> <strong>           [mailarchive]</strong><br />   <table  border=0 class=wiki >  <tbody><tr><td>codecaliases  </td><td> 読み込み時のコーデック変換エイリアスをしています。変換しない場合は不要です。<br /> 以下の書式で記載してください。<br />       <ul><li>メールの文字コード:pythonのコーデック名[,メールの文字コード:pythonのコーデック名]...</li></ul> </td></tr><tr><td>pop3_server  </td><td>pop3サーバのアドレスを指定します。pop3受信しない場合は不要です。 <br /> </td></tr><tr><td>pop3_user  </td><td> pop3サーバへ接続するためのアカウントを指定します。pop3受信しない場合は不要です。</td></tr><tr><td>pop3_password  </td><td> pop3サーバへ接続するためのパスワードを指定します。<br /> </td></tr><tr><td>pop3_delete  </td><td>pop3サーバのメールを削除するかどうかを指定します。(デフォルト:none)<br /> pop3受信しない場合は不要です。<br />       <ul><li>none:削除しない。</li><li>imported:インポートできたもののみ削除する。</li><li>all:すべて削除する。 </li></ul> </td></tr></tbody>        </table>           <p>なお、日本では、codecaliasesにiso-2022-jp:iso-2022-jp-2004      を指定するのがお勧めです。<br /> </p>   <h3 id="4.3 取込み方法 ">4.3 取込み方法 </h3>    <h4 id="(1) メールファイル(unixmail形式)のインポート">(1) メールファイル(unixmail形式)のインポート</h4>     あなたの手元にあるメールをまとめてインポートします。メールファイルのインポートを行わない場合は、この章は飛ばしてください。<br />  unixmail形式のメールをインポート可能です。<br />    <h4 id=" "> </h4>  メールを取込むには、以下のコマンドを実行してください。<br />  ML名には、メーリングリストの(短い)名前を指定してください。画面に表示する際に、ここで指定したML名をキーにして分類されます。<br />  メールの取込み状況およびエラーは、標準出力に出力されます。<br />     <pre>$ python mailarchive-admin.py [TracEnvのディレクトリ] import [ML名] [インポートするファイルのパス]<br /></pre>  例:<br />   <pre>$ python mailarchive-admin.py /var/trac/tracenv import mailarc-ML /tmp/mail_2006<br /></pre>    <h4 id="(2) pop3メールの受信">(2) pop3メールの受信</h4>  pop3サーバからメールを受信します。pop3メールの受信を行わない場合は、この章は飛ばしてください。<br />  <br />   メールを受信するには、以下のコマンドを実行してください。[[FootNote(Trac.iniのpop3_*を事前に指定して置いてください)]]<br />   ML名には、メーリングリストの(短い)名前を指定してください。画面に表示する際に、ここで指定したML名をキーにして分類されます。<br />  メールの取込み状況およびエラーは、標準出力に出力されます。<br />       <pre>$ python mailarchive-admin.py [TracEnvのディレクトリ] pop3 [ML名]<br /></pre>   例:<br />     <pre>$ python mailarchive-admin.py /var/trac/tracenv pop3 mailarc-ML<br /></pre>    取り込みを行うシェルを書いて、cronに設定しておくとよいでしょう。[[FootNote(Windowsではバッチをかいてタスクに登録ですね。)]]<br />  シェルの例[[FootNote(パスはあなたの環境に合わせて書き換えてください)]]:<br />   <pre>#!/bin/csh<br /><br />source $HOME/.cshrc<br />python /local/bin/mailarc-admin.py /var/trac/tracenvmailarc &gt;&gt; /var/trac/repo/log/mailarc.log<br /></pre>      <h2 id=" "> </h2>   <h2 id="5. カスタマイズ ">5. カスタマイズ </h2>  <br /> [[FootNote]]<br />  [[AddComment(appendonly)]] 
     3<h1 id="!MailArchivePlugin">!MailArchivePlugin</h1>    <h2 id="1. 概要">1. 概要</h2>      <p>MLなどのメールを保管し、Tracにて表示・検索するためのプラグインです。  <br /> プロジェクトですでに使用しているMLがあり、その内容をTracで一元管理したい場合にお使いください。<br /> <span class="wiki">([http://trac-hacks.org/wiki/EmailtoTracScript EmailtoTracScript]                                </span>の様に、メールをチケットに投入する機能はありません。)<br /> </p>   <p>Tracの強力なリンク機能を利用できます。たとえば、Wikiで特定のメールを示すリンクを作成したり、メールの本文に書かれたチケットの番号をリンクにしてしまうことが可能です。また、検索やタイムラインといったTracの基本機能にも対応しています。<br /> <br />      </p>    <h2 id="2. 主な機能">2. 主な機能</h2>    <ul> <li>メールのインポート<br /> unixmail形式のメールのインポートします。添付ファイルはTracのAttachementとして管理します。<br />     <br /> </li><li>メールサーバからのメール受信<br /> pop3でサーバから直接メールを受信可能です。<br /> <br />   </li><li>読み込んだメールのスレッドツリー表示<br /> ML名ごと・月ごとにメールをスレッド表示します。<br />     [[Image(MailArc001mini.png)]]<br /> <br /> </li><li>メール本文のWiki表示<br /> メール本文にTracのwiki構文で解釈し、リンクに変換します。 たとえばメール本文内に<em>!#1</em>という文字があれば、チケットの!#1へのリンクに変換します。<br />     [[Image(MailArc005mini.png)]]<br />   </li> </ul>   <ul> <li>メールの検索<br /> Tracの検索機能で、メールのサブジェクトと本文を検索可能です。<br />     [[Image(MailArc003mini.png)]]<br /> <br /> </li><li>メールのタイムライン表示<br /> Tracのタイムライン機能で、メールの送信日をもとにタイムラインとして表示可能です。<br /> チケットの登録やリポジトリのコミットと、メールの送信日をいっしょに表示することが出来ます。<br />     [[Image(MailArc004mini.png)]]<br /> <br />  </li><li>Wikiでリンク指定<br /> Tracの強力なリンク機能をメールにも適用します。Wikiにメール単体をさすリンクを指定可能です。Message-IDや、MLで良く使われるサブジェクト([aaa:001],[aaa 001]など)を リンクにします。<br />     <br /> </li> </ul>    <h2 id="3. セットアップ">3. セットアップ</h2>   <h3 id="3.1 ダウンロード">3.1 ダウンロード</h3>  以下からダウンロードしてください。<br />  ・!MailArchivePlugin Version 0.1<br />   <h3 id="3.2 インストール">3.2 インストール</h3>  MailArchivePluginのインストールを行います。[[FootNote(Tracのプラグインに共通する説明は、[wiki:TracPlugins TracPlugins]を参照してください。)]]<br />        <h4 id="(1) eggの設置 ">(1) eggの設置 </h4>       <p>zipを解凍してください。<br /> 解凍して出来たフォルダ配下のsrcディレクトリに移動してください。<br /> 以下のコマンドを実行して下さい:  </p>     <pre class="wiki">$ python setup.py bdist_egg<br /></pre>      <p> distフォルダが作成されます。<br /> その中にある*.eggファイルを、TracEnvのplugins ディレクトリにコピーしてください。<br /> </p>     <h4 id="(2) TracEnvのupgrade">(2) TracEnvのupgrade</h4>  DBにMailArchivePlugin用のテーブルを追加するために、TracEnvをupgradeする必要があります。以下のコマンドを実行してください。<br />   <pre>$ trac-admin [TracEnvのディレクトリ] upgrade<br /></pre>   <h4 id="(3) Trac.iniの設定">(3) Trac.iniの設定</h4>  MailArchivePluginを使用可能にするには、Trac.iniの[components]カテゴリに以下を加えてください。<br />  (pluginフォルダに置いた場合には不要)<br />     <pre>[componets]<br />mailarchiveplugin.* = enabled<br /></pre>  ここまでで、MailArchivePluginのインストールは終了です。メインメニューに「メール倉庫」というメニューが追加されていると思います。<br />    ただし、まだメールをインポートしてないので、メニューを押しても何も表示されません。<br />    引き続き、メールをインポートするための設定と、メールのインポートを行ってください。<br />  <br />     <h2 id="4. メールのインポート">4. メールのインポート</h2>   <h3 id="4.1 説明">4.1 説明</h3>    <p>MailArchivePluginでメールを表示・検索するには、まずメールデータをTracに取込む(=インポートする)必要があります。<br />  </p> メー ルをインポートするには、2通りの方法があります。unixmail形式のメールファイルのインポートと、pop3サーバからのメールの受信です。「片方 の方法だけ使う」ことも可能ですし、「最初に今までのメールをインポートしてから、今後はpop3でメールを受信する。」というような使い方をも可能で す。<br />        <blockquote><strong>注意:</strong><br />   <ul><li>メールのデータはTracEnvのデータベースに保存します。ディスク使用量に注意してください。大抵はメールのほうがTracに蓄積されたデータよりも大きいので。。</li><li>メー ルの添付ファイルはTracのAttachmentとして保存します。Trac.iniに記載されたサイズより大きな添付ファイルは取り込み出来ません。 Trac.iniの[attachment]のmax_size(デフォルトは262,144Byte)を大きくしたほうがよいでしょう。</li><li>HTML形式のメールは取り込み出来ません。</li><li>マ ルイチなどの記号文字は取り込み出来ない可能性が高いです。これは日本でのメールの標準的な文字コードがJISであるところか らくる仕様です。(どうしても取り込みたければ、コーデックを開発してTrac.iniの[mailarchive]のcodecaliasに設定してく ださい。)</li><li>メールデータのユニークキーはMessage-IDです。すでにDBに同じMessage-IDのメールがDBに存在する場合は、新しく取込んだメールで上書きします。<br />     </li></ul> </blockquote>              <h3 id="4.2 設定 ">4.2 設定 </h3>    Trac.iniの以下の項目を設定してください。 <br />  <br /> <strong>           [mailarchive]</strong><br />   <table  border=0 class=wiki >  <tbody><tr><td>codecaliases  </td><td> 読み込み時のコーデック変換エイリアスをしています。変換しない場合は不要です。<br /> 以下の書式で記載してください。<br />       <ul><li>メールの文字コード:pythonのコーデック名[,メールの文字コード:pythonのコーデック名]...</li></ul> </td></tr><tr><td>pop3_server  </td><td>pop3サーバのアドレスを指定します。pop3受信しない場合は不要です。 <br /> </td></tr><tr><td>pop3_user  </td><td> pop3サーバへ接続するためのアカウントを指定します。pop3受信しない場合は不要です。</td></tr><tr><td>pop3_password  </td><td> pop3サーバへ接続するためのパスワードを指定します。<br /> </td></tr><tr><td>pop3_delete  </td><td>pop3サーバのメールを削除するかどうかを指定します。(デフォルト:none)<br /> pop3受信しない場合は不要です。<br />       <ul><li>none:削除しない。</li><li>imported:インポートできたもののみ削除する。</li><li>all:すべて削除する。 </li></ul> </td></tr></tbody>        </table>           <p>なお、日本では、codecaliasesにiso-2022-jp:iso-2022-jp-2004        を指定するのがお勧めです。<br /> </p>   <h3 id="4.3 取込み方法 ">4.3 取込み方法 </h3>    <h4 id="(1) メールファイル(unixmail形式)のインポート">(1) メールファイル(unixmail形式)のインポート</h4>     あなたの手元にあるメールをまとめてインポートします。メールファイルのインポートを行わない場合は、この章は飛ばしてください。<br />  unixmail形式のメールをインポート可能です。<br />    <h4 id=" "> </h4>  メールを取込むには、以下のコマンドを実行してください。<br />  ML名には、メーリングリストの(短い)名前を指定してください。画面に表示する際に、ここで指定したML名をキーにして分類されます。<br />  メールの取込み状況およびエラーは、標準出力に出力されます。<br />     <pre>$ python mailarchive-admin.py [TracEnvのディレクトリ] import [ML名] [インポートするファイルのパス]<br /></pre>  例:<br />   <pre>$ python mailarchive-admin.py /var/trac/tracenv import mailarc-ML /tmp/mail_2006<br /></pre>    <h4 id="(2) pop3メールの受信">(2) pop3メールの受信</h4>  pop3サーバからメールを受信します。pop3メールの受信を行わない場合は、この章は飛ばしてください。<br />  <br />   メールを受信するには、以下のコマンドを実行してください。[[FootNote(Trac.iniのpop3_*を事前に指定して置いてください)]]<br />   ML名には、メーリングリストの(短い)名前を指定してください。画面に表示する際に、ここで指定したML名をキーにして分類されます。<br />  メールの取込み状況およびエラーは、標準出力に出力されます。<br />       <pre>$ python mailarchive-admin.py [TracEnvのディレクトリ] pop3 [ML名]<br /></pre>   例:<br />     <pre>$ python mailarchive-admin.py /var/trac/tracenv pop3 mailarc-ML<br /></pre>    取り込みを行うシェルを書いて、cronに設定しておくとよいでしょう。[[FootNote(Windowsではバッチをかいてタスクに登録ですね。)]]<br />  シェルの例[[FootNote(パスはあなたの環境に合わせて書き換えてください)]]:<br />   <pre>#!/bin/csh<br /><br />source $HOME/.cshrc<br />python /local/bin/mailarc-admin.py /var/trac/tracenvmailarc &gt;&gt; /var/trac/repo/log/mailarc.log<br /></pre>      <h2 id=" "> </h2>   <h2 id="5. カスタマイズ ">5. カスタマイズ </h2>  <br /> [[FootNote]]<br />  [[AddComment(appendonly)]] 
    44}}}