manakai (旧称 Message::* Perl modules)

注意: この文書の内容には古い事柄が含まれています。最新の情報は SuikaWiki:manakai をご覧ください。

はじめのはじめに

たとえば Perl で書かれた CGI script, それも掲示板なんかには、こんなみっともない code が載っていたりします。

jcode'convert(*from, "jis");
jcode'convert(*subject, "jis");
jcode'convert(*message, "jis");
open (MAIL, "| $sendmail");
print MAIL "From: $mail ($from)\n";
print MAIL "To: $mailto\n";
print MAIL "Subject: $subject\n";
print MAIL "\n";
print MAIL "$message";
print MAIL "\n";
close (MAIL);

これでは視認性も良くないですし、うっかり修正し間違えると変なメッセージを送信してしまいます。 (筆者はしょっちゅうはまってました:-) (それに多くの code では、 HTML でのクロスサイトスクリプティング (CSS) 問題と類似の問題への対処をしていません。)

オブジェクト指向を取り入れて次のような感じでメッセージを構成したいところです。

use Message::Entity;
my $msg = new Message::Entity;
my $hdr = $msg->header;
$hdr->add ('From')->add ('me@bar.example');
$hdr->add ('To')->add (['foo@bar.example', display_name => 'Mr. foo']);
$hdr->add (Subject => $subject);
$msg->body ($body);

# $smtp->send は SMTP で送信する method と仮定。
$smtp->send ($msg);

CPAN を探すと、これに似たようなことができそうなモジュールはあるようですが、実際に使ってみると、与える値によっては RFC 822/2822 に違反する結果を出力するとか、そもそもそれ以前に、 $hdr->addr ('Foo Bar <foo@bar.example>') のようにメッセージ形式をモジュール内に隠匿しきれていないとか、非 ASCII 文字を考慮していないとかの不満があります。

(実装方針としては不正な値はモジュールに渡す前に弾くべきという考え方もあるでしょうけど、一般的な利用に際しては賢い設計だとは思えません。)

ということで、はじめは既存のモジュールの wrapper (あるいは補完) を書くつもりでしたが、なんだかごちゃごちゃしていて、それなら車輪の再発明になっても一から書いてみようと考えました。

特色 (という程のものでもない。)

結構オブジェクト指向です。
RFC 822/2822 の group を解釈出来ます。
draft-ietf-usefor-msg-id-alt-00 に基づいた送信アドレスなどによる Message-ID を生成出来ます。
文字コード変換処理を外部に追い出しています。 jcode.pl でも Jcode.pm でも Encode::* でも、好きなものをお使い下さい。
MIME (RFC 2045, 2046) にほぼ完全に対応しています。

各仕様への対応状況

電子メイルのメッセージ (RFC 822, RFC 2822) の全機能に対応しています。
電子ニュース記事 (RFC 1036, son-of-RFC1036, draft-usefor-article (06)) の頭領域の多くに対応しています。
MIME の本文部分 (body part) に対応しています。
- 多部分 (multipart) や分割 (message/partial), 外部本分 (message/external-body) を扱うことが出来ます。
- text/plain; format=flowed (RFC 2646) に対応しています。
- Content-Transfer-Encoding は Base64, Quoted-Printable は勿論、 x-uuencode, x-gzip64 にも対応。 RFC 2822 メイル出力モードでは、本文が8ビットでも自動的に適切な CTE で符号化します。
MIME の頭領域 (RFC 2045, Content-Disposition) に対応しています。パラメーター値拡張 (RFC 2231) も入出力ともに実装しました。
MIME 符号化語 (encoded-word) の解読に対応しています:-)
HTTP/1.0, HTTP/1.1, CGI/1.1, CGI/1.2 の頭領域のうち、ごく一部に対応しています。 MHTML の Content-Location にも対応しています。
日付形式では RFC 822/1123, RFC 733, asctime, ISO 8601 (HTML) などに対応しています。日付の出力は sprintf の様な書式文字列を与えることで、多種多様な形式に対応。
X-Moe シリーズに対応しています:-)

制限事項

類似モジュール(謎)のように、ファイル名やファイル・ハンドルを渡して読み込ませることが出来ません。
大きなメッセージでも一気に読み込み、全て主記憶領域で保持しています。ですからあまり大きなメッセージの処理には向いていないでしょう。
CR や LF が単体で出現する場合、正しく処理出来~~ません~~ないことがあります (近い将来の版で改善の予定)。 (CRLF と等価とみなします。) 将来の版ではオプションで制御可能になるかもしれません。
説明文 (document; pod) がいい加減です (書くのが面倒だ)。

必要環境

Perl 5.6 以降
comment を表すのに正規表現 (??{ code }) を使っているので、これを解釈出来る、 5.6 以降の版である必要があります。
Digest::MD2, Digest::MD5, Digest::SHA1
Message-ID の生成にこれらを使用する場合のみ、 Message::Field::MsgID が使います。

Content-MD5: 領域の付加や検証を行う場合、 Digest::MD5 が必要です。 (Message::Entity)
MIME::Base64
ちなみに、 Quoted-Printable や RFC 2231 の % 符号化は自力で復号します。
文字コード変換処理
日本語メッセージを扱うなら必須でしょう。詳しくは文字コードの扱いの章をご参照下さい。