Sisimai::Factのデータ構造
Sisimaiのrise()メソッドは解析したデータを Sisimai::Factオブジェクトを複数個含む配列にして返します。 Sisimai 5.0.0で従来のSisimai::Dataオブジェクトは廃止になりました。 返ってきたオブジェクトは以下のようなデータ構造になっています。
Sisimaiのrise()メソッドは解析したデータを Sisimai::Factオブジェクトを複数個含む配列にして返します。 Sisimai 5.0.0で従来のSisimai::Dataオブジェクトは廃止になりました。 返ってきたオブジェクトは以下のようなデータ構造になっています。
"action" はバウンスメール内のAction:
フィールドの値を保持します。この項目は、解析の過程で表記の揺れ(deliverable, failureなど)は修正され、
次の五つの値となります。
Action: failed
"addresser" はバウンスメール内にある元メールの
発信者アドレス(From)から作られるSisimai::Address オブジェクトです。
Sisimai::FactオブジェクトをJSON形式にダンプした場合はメールアドレス
(文字列)を保持します。
From: "Kijitora Cat" <kijitora@example.org>
"alias" は受信者アドレスのエイリアスです。
バウンスメール内のOriginal-Recipient: フィールドや
"expanded from"に続くメールアドレスが記述されていたら、
そこから値を取り出します。
Original-Recipient: rfc822;kijitora@example.org
"|IFS=' ' && exec /usr/local/bin/procmail -f- || exit 75 #kijitora"
(expanded from: <kijitora@neko.example.edu>)
"catch" はSisimaiのrise()メソッドに渡した
フックメソッドが返した値を保持します。フックメソッドを渡さなかった場合は、Perlなら
undef、Rubyならnilとなります。
コールバック機能とフックメソッドの設定、catch()
メソッドはSisimai 4.19.0で追加されました。
Sisimai 5.0.0でコールバック機能の引数名と引数の型が変更になりました。詳細は Callback feature をご覧下さい。
"deliverystatus"はバウンスメール内の Status:
フィールドの値を保持します。もしもバウンスメールに Status:
フィールドが無かった場合は "5.0.9XX"のような内部コードが
入る事があります。この値の形式は "4.x.x" か
"5.x.x" あるいは "2.x.x"
のような文字列となります。
Status: 5.0.0 (permanent failure)
"destination" は受信者アドレスのドメインパートを値として保持します。
この値は recipient() アクセサのhost()メソッドが返す値と同じです。
"diagnosticcode" はバウンスメール内のDiagnostic-Code:
フィールドまたはバウンスメールの本文から取り出したエラーメッセージを保持します。
この値と "diagnostictype", "action", "deliverystatus", "replycode", "smtpcommand" の各値はバウンス理由を決定する為に Sisimai::Reasonクラスから参照されます。
Diagnostic-Code: SMTP; 554 5.4.6 Too many hops
"diagnostictype"はバウンスメール内のDiagnostic-Code:
フィールドの先頭部分、SMTP や X-Unix のような値を保持します。
Diagnostic-Code:フィールドが無い場合、この値は空になります。
Diagnostic-Code: X-Unix; 255
"feedbacktype" はバウンスメール内のFeedback-Type:
フィールドの値で、abuse, fraud,
opt-outのような値を保持します。
バウンスメールがARFフォーマットではない、または"reason"
の値が "feedback"ではない場合、この値は空になります。
Content-Type: message/feedback-report
Feedback-Type: abuse
User-Agent: SMP-FBL
Sisimai 5.0.0で新たに実装された"hardbounce"は、
宛先メールアドレスが二度と配信できない理由でバウンスしたかどうかを示す真偽値
(Perl版は0か1,
Ruby版はtrueかfalse)
を返します。
具体的には"reason"が次の値である 場合に真となります。
同時に"softbounce"はSisimai 5.0.0で廃止となりました。
"lhost" はバウンスメール内の Reporting-MTA:
フィールドの値または Receivedヘッダから取り出した
送信に使われたMTAのホスト名またはIPアドレスを保持します。
Reporting-MTA: dns; mx4.smtp.example.co.jp
"listid"はバウンスメールに含まれる元メッセージから
List-Id:ヘッダの値を取り出したものを保持します。
元メッセージが無い形式のバウンスメールの場合、この値は空になります。
List-Id: General discussion list for Cats <neko-list.example.org>
"messageid"はバウンスメールに含まれる元メッセージの
Message-Id:ヘッダーの値を保持します。
バウンスメールに元メッセージが無い場合、この値は空になります。
Message-Id: <201310160515.r9G5FZh9018575@smtpgw.example.jp>
"origin"はバウンスメールに含まれる元メッセージの
ファイル名(パスを含む)を保持します。具体的にはSisimaiクラスのrise()
メソッドやdump()に渡した第一引数です。Maildir/の場合は第一引数のディレクトリ名に
ここのファイル名が結合された文字列が入ります。
標準入力から読み込んだ場合は<STDIN>が、
変数から読み込んだ場合は<MEMORY>が、それぞれ値となります。
"origin"はv4.25.6で実装されました。
"reason"はSisimaiが検出したバウンス理由
(メールが配信エラーになった理由)を保持します。
値が"undefined"か "onhold"
の時はSisimaiがバウンス理由を特定出来なかった事を意味します。
Sisimaiが検出出来るバウンス理由の一覧は バウンス理由の一覧のページで確認出来ます。
