コマンドラインツール

bounceHammerをインストールすると、いくつかのコマンドラインツールが使えるようになります。bin/ディレクトリの中にインストールされたコマンドは、解析や集積、維持、管理などそれぞれ役割を持っています。

まずはバウンスメールの解析から

これらのコマンドを使う前提として、全ては解析すべきバウンスメール(エラーで返ってきたメール)が存在するところから始まります。bounceHammerは、ファイルとしての電子メール(メールソフトで受信したもの等)やメールボックス(メールサーバに保存されているmbox形式)、メールフォルダ(メールサーバに保存されているMaildir形式)等、必要な電子メールヘッダと内容を含むテキストデータを元データとして解析を行います。

手元のPCやサーバに残っている過去に受信したメールでも解析が可能です。

mailboxparser - 解析

bounceHammerの解析エンジンが、元データからエラー理由(宛先不明、メールボックスがいっぱい、存在しないドメイン等に加えて携帯電話に特有のドメイン指定拒否、ほか多数)と宛先分類(携帯電話、スマートフォン、Webメール、PC)を抽出します。
この処理はmailboxparserコマンドが担当し、解析結果はファイルとして保存されます。

logger - 集積

bounceHammerの解析エンジン/mailboxparserコマンドがデータ化してファイルに保存した内容は、集積プログラムによって時系列に並べられ日付ごとのファイルとして整理・保存されます。
この処理はloggerコマンドが担当します。

databasectl - 維持

集積プログラム/loggerコマンドによって1日1ファイルとして集積された解析済みデータは、維持プログラムによって逐次データベースに記録されます。記録する際に、発信者アドレス(Addresser)と受信者アドレス(Recipient)の組み合わせが既にデータベースに存在した場合は、記録するデータとデータベースに存在するデータを照合し、新しければ最新の情報(別のエラー理由、差し戻し日時等)で上書きします。
この処理はdatabasectlコマンドが担当します。

datadumper - 出力

データベースに蓄積されているデータは、参照プログラムによって閲覧(全件表示や最新のものから確認等)、検索(携帯電話のみ、メールボックスがいっぱいの状態のもののみ等の指定条件)が可能です。出力形式はプログラムとの照合用に便利なYAML/JSONです。
この処理はdatadumperコマンドとブラウザベースの管理画面(WebUI)が担当します。

summarizer - 集約

データベースに蓄積されている、またはファイルに書出されたバウンス記録は、集約プログラムによって項目別の集約結果、基本統計量を得る事が可能です。 この処理はbounceHammer 2.4.0から登場したsummarizerコマンドとブラウザベースの管理画面(WebUI)が担当します。

tablectl, messagetoken - 管理

BounceHammerのデータベースのマスターテーブル(発信者ドメイン:SenderDomains, 宛先ドメイン:Destinations, 宛先分類:HostGroups, 宛先所属:Providers, 差戻理由: Reason)の操作は、テーブル制御コマンドtablectlを使用します。マスターテーブルの操作は、制御可能な部分は限定されていますが管理画面(WebUI)からも可能です。

また、データベースに保存されているバウンスの記録をに特定するためのメッセージトークン(発信者アドレス:Addresserと受信者アドレス:Recipientから作られる一意の文字列)は、messagetokenコマンドまたは管理画面(WebUI)で生成可能です。メッセージトークンはAPIで任意の記録を取り出すためにも使用します。