mailparser 0.4.22a

data/HISTORY

@@ -0,0 +1,141 @@
+== 0.4.22 2010-06-11 ==
+* 添付ファイルの末尾の改行コードを削除してしまっていたバグを修正
+
+== 0.4.21 2010-06-03 ==
+* :use_file オプション追加
+* 省メモリ化
+* Content-Type が text の時にだけ charset 変換するように修正
+
+== 0.4.20 2010-05-04 ==
+* ヘッダが8bit文字を含む場合に MailParser::Header#each が落ちることがあるバグを修正
+
+== 0.4.19 2009-05-12 ==
+ * Received に \v が含まれていると無限ループになっていたバグを修正
+   cf. http://redmine.ruby-lang.org/issues/show/1196
+
+== 0.4.18 2009-01-27 ==
+ * トークンが非常に多い文字列のパースに時間がかかっていた
+
+== 0.4.17 2008-11-26 ==
+ * 閏秒が 23:59:60 しか考慮されていなかったバグを修正
+
+== 0.4.16 2008-07-28 ==
+ * uuencode エンコーディングに対応
+
+== 0.4.15 2008-06-25 ==
+ * 「group:, hoge@example.com;」の形式で落ちていたバグを修正
+
+== 0.4.14 2008-04-03 ==
+ * 値がない Received ヘッダで落ちるバグを修正
+ * Header#[] で nil 値は返さないように修正
+ * Content-Type の subtype がない場合、type が text 以外でも plain になっていた。"" を返すように修正
+ * 値がない Keywords ヘッダが [nil] を返していた。[] を返すように修正
+
+== 0.4.13 2008-03-09 ==
+ * Quoted-Printable のデコード時に、= の後に改行が連続していると行が結合してしまっていたバグを修正
+
+== 0.4.12 2008-01-24 ==
+ * Message-Id が不正な形式の場合、空白文字を含んだIDを返していた
+
+== 0.4.11 2008-01-15 ==
+ * 日付の判定を厳密にした
+
+== 0.4.10 2007-11-06 ==
+ * Content-Transfer-Encoding が空の場合に落ちるバグを修正
+
+== 0.4.9 2007-10-04 ==
+ * :charset_converter 追加
+
+== 0.4.8 2007-09-17 ==
+ * < > がない Message-Id で落ちていた
+ * Message#body_preconv 追加
+
+== 0.4.7 2007-08-29 ==
+ * boundary 文字列の直前の行の改行コードを無視しないといけなかった (RFC2046)
+ * Message.new の第一引数に渡すオブジェクトに必要なメソッドを each_line から gets に変更
+ * Content-Type ヘッダがない場合/charset パラメータがない場合、Message#charset が nil を返すように変更
+ * racc コンパイル済み .rb ファイルを同梱
+ * MailSuite::Message が String も受け付けるようにした
+
+== 0.4.6 2007-08-09 ==
+ * :keep_raw 指定時、ヘッダの継続行が二重になっていた
+
+== 0.4.5 2007-08-07 ==
+ * :decode_mime_filename 指定時、Content-Type も Content-Disposition もない場合に、落ちていたバグを修正
+ * 空の Content-Type, Content-Disposition でエラーになっていた
+ * ヘッダ行のみで区切りの空行がないパートを正しく扱えてなかった
+ * Message#raw の効率化
+ * Obsolete: RFC2231形式の添付ファイル名が正しく取得できないことがあった
+
+== 0.4.4 2007-08-06 ==
+ * :keep_raw オプション追加。
+ * Message#raw メソッド追加。
+
+== 0.4.3 2007-06-01 ==
+ * ヘッダと本文の間の区切りの空行が無い場合にエラーになっていたバグを修正
+ * RFC2231 パラメータが不正な時、strict=false でも ParseError になっていた
+ * In-Reply-To, References ヘッダを正しくパースできなかったバグを修正
+
+== 0.4.2 2007-03-20 ==
+ * 添付ファイルがネストされていた場合、その次の添付ファイルを取り出せなかったバグを修正。
+
+== 0.4.1a 2007-03-06 ==
+ * 64bit環境や非JST環境でもテストが通るようにテストコードを変更。
+
+== 0.4.1 2007-03-03 ==
+ * ドキュメントの誤記修正。
+ * パース結果オブジェクトに raw メソッド追加。
+ * :extract_message_type を :text_body_only, :skip_body よりも優先するように変更。
+ * :output_charset 指定時にRFC2232形式のファイル名の charset が変換されていなかった
+ * Content-Type, Content-Disposition のパラメータが未知の charset でエンコーディングされていた場合に落ちていたバグを修正。
+
+== 0.4 2007-01-16 ==
+ * イチから作りなおした。0.3 とは互換なし。
+
+== 0.3.9 2006-07-10 ==
+ * text_body_only が true で Content-Type ヘッダがない場合に、メールの本文をないものとして扱っていたバグを修正。
+
+== 0.3.8 2006-03-30 ==
+ * RFC 2231 に対応。
+
+== 0.3.7 2006-03-11 ==
+ * From, To, Cc の行末が「\」の時に無限ループしていたバグを修正。
+
+== 0.3.6 2005-10-14 ==
+ * phrase内に「&lt;」「&gt;」「(」「)」があった時にメールアドレスの取得に失敗するバグを修正。
+ * 「(」「)」「\(」「\)」が多く存在する行のパースに長時間かかるバグを修正。
+ * quoted-string内の「(～)」を除去してしまうバグを修正。
+
+== 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 ==
+ * 公開

data/README.txt

@@ -0,0 +1,501 @@
+= MailParser =
+
+メールメッセージを解析する。
+
+== 作者 ==
+
+とみたまさひろ <tommy@tmtm.org>
+
+== ライセンス ==
+
+Ruby ライセンス http://www.ruby-lang.org/ja/LICENSE.txt と同等。
+
+== 機能 ==
+
+ * メールファイルをパースした結果を返す。
+ * メール構造による例外は発生しない(例外を発生させることも可能)。
+   不正な構造のメッセージがあった場合は適当に処理する。
+
+ * 0.4 でイチから作りなおしたので、0.3 とは互換がない。
+   require "mailparser/obsolete" すれば 0.3 と同じ機能が使用可能。
+
+== ダウンロード ==
+
+ * http://github.com/tmtm/mailparser
+
+== インストール ==
+
+インストールには racc が必要。
+
+{{{
+$ make
+$ make test
+# make install
+}}}
+
+== 使用例 ==
+
+{{{
+require "mailparser"
+File.open("/tmp/hoge.eml") do |f|
+  m = MailParser::Message.new(f, :decode_mime_header=>true)
+  m.from                # => From ヘッダ (MailParser::RFC2822::Mailbox)
+  m.to                  # => To ヘッダ (MailParser::RFC2822::Mailbox の配列)
+  m.subject             # => Subject 文字列 (String)
+  m.body                # => 本文文字列 (String)
+  m.charset             # => 本文文字コード (String)
+  m.part                # => 添付ファイル (MailParser::Message の配列)
+  m.part[0].filename    # => １つめの添付ファイルのファイル名 (String)
+  m.part[0].body        # => １つめの添付ファイルの本文 (String)
+end
+}}}
+
+== MailParser::Message ==
+
+=== self.new(io, [opt]) ===
+ 
+io から MailParser::Message オブジェクトを生成する。
+
+io には IO または StringIO オブジェクトを指定する。実際には１行毎の文
+字列を返す gets イテレータを持ち、処理した位置を覚えていて次回実
+行時に続きから実行できるオブジェクトであれば何でも良い。
+String オブジェクトも指定可能。内部で StringIO が生成されて使用される。
+
+opt は Hash オブジェクトで次の値を指定できる。
+
+ :skip_body => true
+   本文をスキップする。デフォルトは false。
+
+ :text_body_only => true
+   text/* type 以外の本文をスキップする。デフォルトは false。
+
+ :extract_message_type => true
+   message/* type を展開する。デフォルトは false。
+
+ :decode_mime_header => true
+   MIMEヘッダをデコードする。デフォルトは false。
+
+ :decode_mime_filename => true
+   MIME エンコードされたファイル名をデコードする。デフォルトは false。
+   
+ :output_charset => charsetname
+   出力文字コード。デフォルトは nil で無変換。
+
+ :charset_converter => proc{|f,t,s| ...}
+   文字コード変換時に呼び出される Proc オブジェクト。引数は、元charset,新charset,元文字列。デフォルトは MailParser::ConvCharset.conv_charset が呼ばれる。
+
+ :strict => true
+   RFC違反時に ParseError 例外を発生する。デフォルトは false。
+
+ :keep_raw => true
+   生メッセージ文字列を保持する。デフォルトは false。
+
+ :use_file => bytes
+   raw が指定したサイズを超えたら、メモリではなくファイルを使う。nil 指定時は無制限にメモリを使う。デフォルトは nil。
+
+=== from ===
+
+From ヘッダのパース結果の最初のアドレスを MailParser::Mailbox オブジェクトで返す。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS))
+From: TOMITA Masahiro <tommy@tmtm.org>
+EOS
+m.from.display_name   # => "TOMITA Masahiro"
+m.from.addr_spec.to_s # => "tommy@tmtm.org"
+}}}
+
+=== to ===
+
+To ヘッダのパース結果を MailParser::Mailbox オブジェクトの配列で返す。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS))
+To: TOMITA Masahiro <tommy@tmtm.org>, foo@example.com
+EOS
+m.to[0].to_s   # => "TOMITA Masahiro <tommy@tmt.morg>"
+m.to[1].to_s   # => "<foo@example.com>"
+}}}
+
+=== cc ===
+
+Cc ヘッダのパース結果を MailParser::Mailbox オブジェクトの配列で返す。
+
+=== subject ===
+
+Subject ヘッダの値を文字列で返す。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS), :decode_mime_header=>true, :output_charset=>"utf-8")
+Subject: =?iso-2022-jp?b?GyRCJEgkXyQ/JEckORsoQg==?=
+EOS
+m.subject    # => "とみたです"
+}}}
+
+=== type ===
+
+Content-Type ヘッダのタイプを小文字の文字列で返す。
+Content-Type がない場合は "text" を返す。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS), :decode_mime_header=>true, :output_charset=>"utf-8")
+Content-Type: Text/Plain; charset=ISO-2022-JP
+EOS
+m.type     # => "text"
+m.subtype  # => "plain"
+m.charset  # => "iso-2022-jp"
+}}}
+
+=== subtype ===
+
+Content-Type ヘッダのサブタイプを小文字の文字列で返す。
+Content-Type がない場合またはサブタイプがない場合は "plain" を返す。
+
+=== charset ===
+
+Content-Type ヘッダの charset 属性を小文字の文字列で返す。
+Content-Type がない場合または charset がない場合は nil を返す。
+
+=== multipart? ===
+
+マルチパートメッセージの場合 true を返す。
+
+=== filename ===
+
+ファイル名を返す。
+ファイル名は、Content-Disposition ヘッダの filename 属性または Content-Type ヘッダの name 属性から取得する(Content-Disposition ヘッダが優先)。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS))
+Content-Disposition: attachment; filename="hogehoge.txt"
+EOS
+m.filename  # => "hogehoge.txt"
+}}}
+
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS))
+Content-Disposition: attachment; filename*=utf-8''%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E5%90%8D.txt
+EOS
+m.filename # => "ファイル名.txt"
+}}}
+
+RFC的には正しくない(でも一般に使われている)ダブルクォートで括られてMIMEエンコードされた文字列を MIMEデコードしたい場合は、:decode_mime_filename=>true を指定する必要がある。
+
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS), :decode_mime_filename=>true)
+Content-Disposition: attachment; filename="=?utf-8?b?44OV44Kh44Kk44Or5ZCNLnR4dA==?="
+EOS
+m.filename # => "ファイル名"
+}}}
+
+=== header ===
+
+ヘッダを表す MailParser::Header オブジェクトを返す。
+MailParser::Header はハッシュのように使用できる。
+キーは小文字のヘッダ名文字列で、値はヘッダオブジェクトの配列(複数存在する場合があるので配列)。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS))
+From: TOMITA Masahiro <tommy@tmtm.org>
+To: foo@example.com
+Subject: test subject
+EOS
+m.header["from"][0]      # => MailParser::Mailbox の配列
+m.header["to"][0]        # => MailParser::Mailbox の配列
+m.header["subject"][0]   # => String
+}}}
+
+ヘッダとパース結果のクラスの対応は次の通り。
+
+|| Date                      || MailParser::DateTime
+|| From                      || MailParser::Mailbox の配列
+|| Sender                    || MailParser::Mailbox
+|| Reply-To                  || MailParser::Mailbox または MailParser::Group の配列
+|| To                        || MailParser::Mailbox または MailParser::Group の配列
+|| Cc                        || MailParser::Mailbox または MailParser::Group の配列
+|| Bcc                       || MailParser::Mailbox または MailParser::Group の配列
+|| Message-Id                || MailParser::MsgId
+|| In-Reply-To               || 文字列または MailParser::MsgId の配列
+|| References                || 文字列または MailParser::MsgId の配列
+|| Keywords                  || 文字列の配列
+|| Resent-Date               || MailParser::DateTime
+|| Resent-From               || MailParser::Mailbox の配列
+|| Resent-To                 || MailParser::Mailbox または MailParser::Group の配列
+|| Resent-Cc                 || MailParser::Mailbox または MailParser::Group の配列
+|| Resent-Bcc                || MailParser::Mailbox または MailParser::Group の配列
+|| Resent-Message-Id         || MailParser::MsgId
+|| Return-Path               || MailParser::Mailbox または nil (<> の場合)
+|| Received                  || MailParser::Received
+|| Content-Type              || MailParser::ContentType
+|| Content-Transfer-Encoding || MailParser::ContentTransferEncoding
+|| Content-Id                || MailParser::MsgId
+|| Mime-Version              || 文字列
+|| Content-Disposition       || MailParser::ContentDisposition
+
+=== body ===
+
+本文文字列を返す。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS))
+From: TOMITA Masahiro <tommy@tmtm.org>
+Content-Type: text/plain; charset=utf-8
+
+これは本文です。
+EOS
+m.body  # => "これは本文です。\n"
+}}}
+
+=== body_preconv ===
+
+本文の charset変換前文字列を返す。
+{{{
+m = MailParser::Message.new(<<EOS)
+From: TOMITA Masahiro <tommy@tmtm.org>
+Content-Type: text/plain; charset=iso-2022-jp
+
+\e$B$3$l$OK\\J8$G$9\e(B
+EOS
+m.body           # => "これは本文です\n"
+m.body_preconv   # => "\e$B$3$l$OK\\J8$G$9\e(B\n"
+}}}
+
+=== part ===
+
+マルチパートメッセージの場合、各パートを表す MailParser::Message オブジェクトの配列を返す。
+マルチパートメッセージでない場合は空配列を返す。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS, :output_charset=>"utf8"))
+Content-Type: multipart/mixed; boundary="abcdefg"
+
+--abcdefg
+Content-Type: text/plain
+
+first part.
+--abcdefg
+Content-Type: text/plain
+
+second part.
+--abcdefg--
+EOS
+m.part.size    # => 2
+m.part[0]      # => 最初のパートの MailParser::Message オブジェクト
+m.part[1]      # => ２番目のパートの MailParser::Message オブジェクト
+}}}
+
+=== message ===
+
+:extract_message_type=>true で message タイプのメッセージの場合、本文が示すメッセージの Mailparser::Message オブジェクトを返す。
+:extract_message_type=>false または message タイプでない場合は nil を返す。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS), :extract_message_type=>true)
+Content-Type: message/rfc822
+
+Subject: message subject
+
+message body
+EOS
+m.message.subject  # => "message subject"
+}}}
+
+=== rawheader ===
+
+ヘッダ部文字列をパースせずにそのまま返す。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS))
+From: TOMITA Masahiro <tommy@tmtm.org>
+To: foo@example.com
+Subject: subject
+
+body message
+EOS
+m.rawheader  # => "From: TOMITA Masahiro <tommy@tmtm.org>\nTo: foo@example.com\nSubject: subject\n"
+}}}
+
+=== raw ===
+
+生メッセージ文字列を返す。:keep_raw=>true である必要がある。
+:keep_raw=>false の場合は空文字列が返る。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS), :keep_raw=>true)
+From: TOMITA Masahiro <tommy@tmtm.org>
+To: foo@example.com
+Subject: subject
+
+body message
+EOS
+m.rawheader  # => "From: TOMITA Masahiro <tommy@tmtm.org>\nTo: foo@example.com\nSubject: subject\n"
+}}}
+
+== MailParser::Header ==
+
+同じ名前を持つヘッダを表すクラス。
+
+=== add(name, body) ===
+name ヘッダの値として body を追加する。
+
+=== [](name) ===
+name ヘッダの値をパースした結果オブジェクトの配列を返す。
+パース結果オブジェクトは raw メソッドを持ち、パース前文字列を取り出すことができる。
+
+=== raw(name) ===
+name ヘッダの値のパース前の文字列の配列を返す。
+
+=== keys ===
+ヘッダ名文字列の一覧を返す。
+
+=== key?(name) ===
+name ヘッダがあれば真。
+
+=== each {|n,v| } ===
+各ヘッダについてブロックを繰り返す。
+ブロック引数は、１番目がヘッダ名文字列、２番目がパース結果オブジェクトの配列。
+
+== MailParser::DateTime ==
+
+Date ヘッダを表すクラス。
+
+=== year ===
+
+年を表す整数。
+
+=== month ===
+
+月を表す整数。
+
+=== day ===
+
+日を表す整数。
+
+=== hour ===
+
+時を表す整数。
+
+=== min ===
+
+分を表す整数。
+
+=== sec ===
+
+秒を表す整数。
+
+=== zone ===
+
+タイムゾーンを表す文字列。「+9999」または「-9999」の形式。
+
+=== time ===
+
+Time オブジェクトを返す。範囲外の日付の場合は :strict が false でも ArgumentError 例外が発生するので注意。
+
+== MailParser::Mailbox ==
+
+メールアドレスを表すクラス。
+
+=== addr_spec ===
+
+メールアドレスを表す MailParser::AddrSpec を返す。
+
+=== local_part ===
+
+ローカルパートを表す文字列。
+MailParser::Mailbox#addr_spec.local_part と同じ。
+
+=== domain ===
+
+ドメインを表す文字列。
+addr_spec.domain と同じ。
+
+=== display_name ===
+
+表示名を表す文字列。
+
+=== phrase ===
+
+display_name と同じ。
+
+== MailParser::Group ==
+
+グループアドレスを表すクラス。
+
+=== mailbox_list ===
+
+MailParser::Mailbox の配列。
+
+=== display_name ===
+
+表示名を表す文字列。
+
+=== phrase ===
+
+display_name と同じ。
+
+== MailParser::MsgId ==
+
+=== msg_id ===
+
+メッセージID文字列。先頭と末尾の < > は含まない。
+
+== MailParser::Received ==
+
+Received ヘッダを表すクラス。
+
+=== name_val ===
+
+Received ヘッダ中の名前(小文字の文字列)と値(文字列)の組を表す Hash を返す。
+{{{
+m = MailParser::Message.new(StringIO.new(<<EOS))
+Received: from mx1.tmtm.org (localhost [127.0.0.1])
+        by mx2.tmtm.org (Postfix) with ESMTP id 3ED69108383
+        for <tommy@tmtm.org>; Tue, 16 Jan 2007 14:20:23 +0900 (JST)
+EOS
+r = m.header["received"][0]
+r.name_val["from"]    # => "mx1.tmtm.org"
+r.name_val["by"]      # => "mx2.tmtm.org"
+r.name_val["with"]    # => "ESMTP"
+r.name_val["for"]     # => "tommy@tmtm.org"
+}}}
+
+=== date_time ===
+
+Received ヘッダ中の日時を表す MailParser::DateTime オブジェクトを返す。
+
+== MailParser::ContentType ==
+
+Content-Type ヘッダのパラメータを表すクラス。
+
+=== type ===
+
+Content-Type ヘッダのタイプを表す小文字の文字列を返す。
+
+=== subtype ===
+
+Content-Type ヘッダのサブタイプを表す小文字の文字列を返す。
+
+=== params ===
+
+Content-Type ヘッダのパラメータを表す Hash を返す。
+Hash のキーは小文字の文字列。値は文字列。
+
+== MailParser::ContentTransferEncoding ==
+
+Content-Transfer-Encoding ヘッダを表すクラス。
+
+=== mechanism ===
+
+Content-Transfer-Encoding ヘッダの値を小文字の文字列で返す。
+
+== MailParser::ContentDisposition ==
+
+=== type ===
+
+Content-Disposition ヘッダのタイプを表す小文字の文字列を返す。
+
+=== params ===
+
+Content-Disposition ヘッダのパラメータを表す Hash を返す。
+Hash のキーは小文字の文字列。値は文字列。
+
+== MailParser::AddrSpec ==
+
+メールアドレスを表すクラス。
+
+=== local_part ===
+
+メールアドレスのローカルパート文字列を返す。
+
+=== domain ===
+
+メールアドレスのドメイン部文字列を返す。