MailParser

メールメッセージを処理するための Module です。

必要なもの

• Ruby 1.8.2

ライセンス

このプログラムは Ruby ライセンスに従います。

機能

• メールを構成する文字列を解析し、Hash, Array, String 等のオブジェクトとして返します。
• 例外は発生しません。不正な構造のメッセージがあった場合は適当に処理します。
• 返される文字列の文字コードは EUC-JP(デフォルト) または UTF-8 です。
• 処理できる charset は ISO-2022-JP, EUC-JP, SHIFT_JIS, UTF-8, US-ASCII です。 それ以外の charset の場合はデコードせずにそのままの文字列を返します。

使用例

require "mailparser"
File.open("/tmp/hoge.eml") do |f|
  m = MailParser.parse_message f
  m[:from]                 # Fromへッダのメールアドレスの配列
  m[:to]                   # Toへッダのメールアドレスの配列
  m[:subject]              # Subjectへッダの内容
  m[:body]                 # メール本文
  m[:parts]                # 添付ファイルに対応する Hash の配列
  m[:parts][0][:filename]  # 一番目の添付ファイルのファイル名
  m[:parts][0][:body]      # 一番目の添付ファイルの内容
end

モジュールメソッド

parse_message(io)

IOオブジェクト(またはそれに似たもの)からメッセージを読み込み、解析した結果を次の Hash オブジェクトで返します。

キー	値
:from	Fromへッダのメールアドレスの配列
:to	Toへッダのメールアドレスの配列
:cc	Ccへッダのメールアドレスの配列
:date	Dateへッダを解析した結果のTimeオブジェクト(Dateへッダがない場合やパースできない場合は nil)
:subject	Subjectへッダの文字列(デコード済)
:type	Content-Typeへッダのメインタイプ
:subtype	Content-Typeへッダのサブタイプ
:charset	Content-Typeへッダのcharsetパラメータの値(小文字)
:encoding	Content-Transfer-Encodingへッダの値(小文字)
:multipart	メインタイプが multipart の場合 true
:boundary	パート毎の区切り文字列(マルチパート時)
:filename	ファイル名
:header	"へッダ名(小文字)"=>"へッダ値(デコード済)"のハッシュ
:rawheader	生のへッダ部
:body	メール本文(デコード済)
:parts	各パートの配列(マルチパート時)。各パートはこれと同じ形式の Hash オブジェクト
:message	メインタイプが message の場合、本文部を解析した結果の Hash オブジェクト

output_charset = str

出力の文字コードを指定します。 指定できる値は nil または "euc-jp" または "utf-8" です。 デフォルトは "euc-jp" です。 nil を指定した時はコード変換を行ないません。

text_body_only = flag

true の場合、:type == "text" 時だけ :body を生成します。 デフォルトは false です。

extract_message_type = flag

false の場合、Content-Type が message/* の時に、それ以上展開しません。 デフォルトは true です。

これ以降は parse_message が内部で使用しているメソッドですが、個々に使用することもできます。

b64_decode(str)

Base64 エンコードされた文字列をデコードします。

MailParser.b64_decode("aG9nZWhvZ2U=")
  # => "hogehoge"

b64_hdecode(str)

Base64 エンコードされたへッダ文字列をデコードします。 b64_decode と同じです。

MailParser.b64_hdecode("aG9nZWhvZ2U=")
  # => "hogehoge"

qp_decode(str)

Quoted-Printable エンコードされた文字列をデコードします。

 MailParser.qp_decode("=A4=DB=A4=B2_=A4=CF=A4=B2")'
  # => "ほげ_はげ"

qp_hdecode(str)

Quoted-Printable エンコードされたへッダ文字列をデコードします。 「_」を空白にすること以外は qp_decode と同じです。

MailParser.qp_hdecode("=A4=DB=A4=B2_=A4=CF=A4=B2")'
  # => "ほげ はげ"

mdecode_token(str)

「=?chaset?encode?xxxxxx?=」の文字列をデコードします。結果の文字コードは EUC-JP です。

MailParser.mdecode_token("=?iso-2022-jp?b?GyRCJFUkLCRVJCwbKEI=?=")
  # => "ふがふが"

mime_header_decode(str)

へッダ文字列をデコードします。結果の文字コードは EUC-JP です。

MailParser.mime_header_decode("foo =?iso-2022-jp?b?GyRCJFUkLCRVJCwbKEI=?= bar")
  # => "foo ふがふが bar"

trunc_comment(str)

コメント部を取り除いた文字列を返します。

MailParser.trunc_comment("aaa (bbb (ccc)) ddd")
  # => "aaa  ddd"

split_address(str)

へッダ文字列を「,」で分割した配列を返します。

MailParser.split_address('aaa@example.jp, hoge <bbb@example.jp>, "fuga,hage" <ccc@example.com>')
  # => ["aaa@example.jp", "hoge <bbb@example.jp>", "\"fuga,hage\" <ccc@example.com>"]

get_mail_address(str)

メールアドレスの配列を返します。

MailParser.get_mail_address('aaa@example.jp, hoge <bbb@example.jp>, "fuga,hage" <ccc@example.com>')
  # => ["aaa@example.jp", "bbb@example.jp", "ccc@example.com"]

parse_content_type(str)

Content-Type へッダ文字列を解析し、次の Hash オブジェクトを返します。 メインタイプ,サブタイプ,パラメータ名は小文字に変換されます。

キー	値
:type	メインタイプ
:subtype	サブタイプ
:parameter	パラメータ名と値の Hash

MailParser.parse_content_type("Text/Plain; CharSet=euc-jp")
  # => {:type=>"text", :subtype=>"plain", :parameter=>{"charset"=>"euc-jp"}}

parse_content_disposition(str)

parse_content_type と同じ。

履歴

0.3.5 2005-06-08

• 本文がHTMLで添付ファイルがついている場合に、添付ファイルが認識されないバグを修正。

0.3.4 2005-05-02

• Date へッダの日付が UNIX 時刻の範囲外の時に落ちるバグを修正。

0.3.3 2005-03-31

• output_charset に nil を指定した時にコード変換しないようにした。

0.3.2 2005-03-01

• From,To,Ccへッダに奇数個の「"」があると無限ループになるバグを修正。

0.3.1 2005-02-21

• extract_message_type=() を追加。

0.3 2005-01-28

• 最初の text/* を :body にするのをやめた。
• :header を Hash に変更。
• :rawheader 追加。
• Uconv ではなく NKF を使用するようにした。

0.2.1 2005-01-28

• 添付ファイルの Content-Type: が multipart/* の時に処理していなかったバグを修正。
• Content-Type が message/* の時、:body が nil ではなく "" になっていたバグを修正。
• 最初の行が空白で始まっていると落ちるバグを修正。

0.2 2005-01-06

• UTF-8対応
• output_charset=(), text_body_only=() を追加
• Test::Unit を使用

0.1 2004/11/02

• 公開

Last modified: Wed Jun 8 18:56:45 JST 2005