FLIM-LB 1.14 MIME 機能説明書 ¶

3.1 Entity の生成 ¶

Function: mime-open-entity type location ¶

Entity を開いて、それを返します。

type は representation-type です。(cf. Entity の表現と実現)

location は entity の位置です。指定方法は representation-type に依って変わります。

Function: mime-parse-buffer &optional buffer type ¶

buffer を message として構文解析し、その結果の mime-entity を buffer のmime-message-structure に格納する。

buffer が省略された場合、現在の buffer を構文解析する。

type が指定された場合、その値を生成される mime-entity の表象型とし て用いる。省略された場合は buffer となる。(cf. Entity の表現と実現)

3.2 Entity 階層 ¶

MIME message は entity を単位とする木構造になっています。

この木において根となる節は message 全体を表す entity です。ここでは、こ れを root-entity もしくはmessage と呼びます。

root-entity 以外の entity は親を持ちます。また、entity は子供を持つかも 知れません。この親子関係を考えることで entity の相対関係を扱うことができ ます。

一方、entity の message における位置を考えることもできます。

entity はこの木における節となりますが、この木には深さと同じ深さの中の 順番に従って番号が付けることができます。即ち、

                              ┌───┐
                              │  nil │
                              └─┬─┘
              ┌─────────┼─────────┐
            ┌┴┐              ┌┴┐              ┌┴┐
            │０│              │１│              │２│
            └┬┘              └┬┘              └┬┘
              │        ┌────┼────┐        │
          ┌─┴─┐┌─┴─┐┌─┴─┐┌─┴─┐┌─┴─┐
          │ ０.０││ １.０││ １.１││ １.２││ ２.０│
          └───┘└───┘└───┘└───┘└───┘

のように深さ n の節には長さ n の整数列の節番号が振れます。これ を entity-number と呼びます。entity-number は S 式と しては (1 2 3) のような整数のリストとして表現されます。

mime-entity では、これと同様の node-id を用います。node-id はちょ うど entity-number を逆にしたリストで、entity-number 1.2.3 に対応する node-id は (3 2 1) です。

前述のように、MIME message は entity を単位とした木構造になっているので、 この根である message 全体も mime-entity で表現することができ、buffer local 変数 mime-message-structure に格納することにします。

mime-message-structure を起点に entity-number や node-id で示される entity を取り出すことができます。

Variable: mime-message-structure ¶

現在の buffer における message 全体の mime-entity 構造体を格納するbuffer local 変数。

Function: mime-entity-children entity ¶

entity に含まれる entity の list を返す。

Function: mime-entity-parent entity &optional message ¶

entity の親の entity を返す。

message が指定された場合、これを根と見倣す。

Function: mime-root-entity-p entity ¶

entity が根（即ち、message 全体）である場合に、非-nil を返 す。

Function: mime-entity-node-id entity ¶

entity の node-id を返す。

Function: mime-entity-number entity ¶

entity の entity-number を返す。

3.3 Entity の検索 ¶

Function: mime-find-entity-from-number entity-number &optional message ¶

message から、enity-number の entity を返します。

message が指定されていない場合は、 mime-message-structrue が使われます。

Function: mime-find-entity-from-node-id entity-node-id &optional message ¶

message から、entity-node-id の entity を返します。

message が指定されていない場合は、 mime-message-structure が使われます。

Function: mime-find-entity-from-content-id cid &optional message ¶

message から、cid の entity を返します。

message が指定されていない場合は、 mime-message-structure が使われます。

3.4 Entity の属性 ¶

Function: mime-entity-content-type entity ¶

entity の content-type を返す。(cf. mime-content-type 構造体)

Function: mime-entity-content-disposition entity ¶

entity の content-disposition を返す。 (cf. mime-content-disposition 構造体)

Function: mime-entity-filename entity ¶

entity の file 名を返す。

Function: mime-entity-encoding entity &optional default-encoding ¶

entity の content-transfer-encoding を返す。 (cf. 符号化法)

もし、entity に Content-Transfer-Encoding 欄が存在しない場合は、 default-encoding を返す。これが指定されない場合は、"7bit" を用いる。

Function: mime-entity-cooked-p entity ¶

entity の内容が既にコード変換されている場合は nil で無い値 を返す。

3.5 Entity header の情報 ¶

Function: mime-fetch-field field-name &optional entity ¶

entity の header 中の field-name 欄の body を返す。

結果の文字列は network 表現のままである。

entity が省略された場合は、mime-message-structure の値を用 いる。

field-name 欄が存在しない場合は nil を返す。

Function: mime-read-field field-name &optional entity ¶

entity の header 中の field-name 欄を構文解析した結果を返す。

結果の形式は欄毎に異なる。非構造化欄の場合は文字列を返し、構造化欄の場合 はその形式に従った list を返す。

結果中の文字列は Emacs の内部表現に変換される。

entity が省略された場合は、mime-message-structure の値を用 いる。

field-name 欄が存在しない場合は nil を返す。

3.6 Entity の文字表現 ¶

Function: mime-insert-header entity &optional invisible-fields visible-fields ¶

現在位置に entity の復号した header を挿入する。

invisible-fields と visible-fields は正規表現のlist で、それ ぞれ、表示したくない field 名と表示したい欄名を表現したものである。

invisible-fields の要素のどれかに match し、かつ、 visible-fields の要素のどれにも match しない欄は表示されない。

encoded-word (Header の network 表現) は復号される。『生の非 us-ascii 文字』 は default-mime-charset として解釈される。

Function: mime-insert-text-content entity ¶

point の前に entity を text entity として挿入します。

entity の内容は MIME charset として復号化され ます。entity の Content-Type field に charset paramter が無 いと、default-mime-charset が初期値として使われます。

Variable: default-mime-charset ¶

適切な MIME charset (MIME charset) が見つからなかった場合に用いら れるMIME charset.

本来は APEL の変数である。

3.7 Entity の内容 ¶

Function: mime-entity-content entity ¶

entity の内容の byte 列を返す。

Function: mime-insert-entity-content entity ¶

point の位置に entity の内容を挿入します。

Function: mime-write-entity-content entity filename ¶

entity の内容を filename に書き込みます。

3.8 Entity のネットワーク表現 ¶

Function: mime-insert-entity entity ¶

entity の header と body を point のところに挿入します。

Function: mime-write-entity entity filename ¶

entity の表現を filename に書き込みます。

Function: mime-write-entity-body entity filename ¶

entity の body を filename に書き込みます。

3.9 Entity の buffer による表現 ¶

Function: mime-entity-buffer entity ¶

entity が存在する buffer を返す。

Function: mime-entity-point-min entity ¶

entity が存在する buffer における、entity が占める領域の先頭 位置を返す。

Function: mime-entity-point-max entity ¶

entity が存在する buffer における、entity が占める領域の末尾 位置を返す。

Function: mime-entity-header-start entity ¶

entity が存在する buffer における、header が占める領域の先頭位置を 返す。

Function: mime-entity-header-end entity ¶

entity が存在する buffer における、header が占める領域の末尾位置を 返す。

Function: mime-entity-body-start entity ¶

entity が存在する buffer における、body が占める領域の先頭位置を返 す。

Function: mime-entity-body-end entity ¶

entity が存在する buffer における、body が占める領域の末尾位置を返 す。

3.10 Entity の表現と実現 ¶

Entity は抽象化されたデータ表現で、実際のデータ表現としては用途に応じて さまざまなものが利用できるように設計されています。

ここで、entity がどういう種類の表現を行っているかを示すのが representation-type で、entity を生成する時にはこれを指定します。 (cf. Entity の生成)

前節までに述べて来た entity に対する処理は、entity に対してその処理を依 頼することによって実現されています。Entity は自分の representation-type を知っており、その representation-type に応じて実際の処理を行う関数を呼 び出します。このような関数を entity 処理method と呼びます。また、 representation-type 毎にこのような関数をまとめたものを mm-backend と呼びます。

mm-backend は representation-type の名前の先頭に mm という 接頭辞を付けた関数名からなる module で、その module 名は同様に representation-type の名前の先頭に mm を付けたものになって います。この module は representation-type の entity が最初に生成される 時に自動的に require されます。

• Entity への便り
• mm-backend の作り方

4.1 Content-Type 欄の形式 ¶

Content-Type 欄の形式は以下のように定義されています：

“Content-Type” “:” type “/” subtype *( “;” parameter )

例えば、

Content-Type: image/jpeg

や

Content-Type: text/plain; charset=iso-2022-jp

などのように用いられます。

ここで、‘type’ と ‘subtype’ は entity の形式を示すもので、両者を総称し て、‘media-type’ と呼ぶことにします。上記の例における ‘image/jpeg’ や ‘text/plain’ は media-type の１つです。

[Memo]

Content-Type 欄のない entity は

Content-Type: text/plain; charset=us-ascii

として解釈される。(cf. us-ascii)

4.2 mime-content-type 構造体 ¶

Structure: mime-content-type ¶

Content-Type 欄の情報を格納するための構造体。

この構造体を参照するには mime-content-type-要素名 という名前の参 照関数を用いる。

この構造体の要素は以下の通りである：

primary-type

media-type の主型 (symbol).

subtype

media-type の副型 (symbol).

parameters

Content-Type 欄の parameter (連想 list).

Function: make-mime-content-type type subtype ¶

&optional parameters

content-type の生成子。

Function: mime-content-type-parameter content-type parameter ¶

content-type の parameter の値を返す。

4.3 Content-Type 欄の解析器 ¶

Function: mime-parse-Content-Type string ¶

string を content-type として解析した結果を返す。

Function: mime-read-Content-Type ¶

現在の buffer の Content-Type 欄を読み取り、解析した結果を返す。

Content-Type 欄が存在しない場合は nil を返す。

4.4 Content-Type に関する有用な関数 ¶

Function: mime-type/subtype-string type &optional subtype ¶

type と subtype から type/subtype 形式の文字列を返す。

5.1 mime-content-disposition 構造体 ¶

Structure: mime-content-disposition ¶

Content-Disposition 欄の解析結果を収めるための構造体。

この構造体を参照するには mime-content-disposition-要素名 という名 前の参照関数を用いる。

この構造体の要素は以下の通りである：

disposition-type

disposition-type (symbol).

parameters

Content-Disposition 欄の parameter (連想 list).

Function: mime-content-disposition-parameter content-disposition parameter ¶

content-disposition の parameter の値を返す。

Function: mime-content-disposition-filename content-disposition ¶

content-disposition の filename の値を返す。

5.2 Content-Disposition 欄の解析器 ¶

Function: mime-parse-Content-Disposition string ¶

string を content-disposition として解析した結果を返す。

Function: mime-read-Content-Disposition ¶

現在の buffer の Content-Disposition 欄を読み取り、解析した結果を返す。

Content-Disposition 欄が存在しない場合は nil を返す。

6.1 Content-Transfer-Encoding 欄の解析器 ¶

Function: mime-parse-Content-Transfer-Encoding string ¶

string を content-transfer-encoding として解析した結果を返す。

Function: mime-read-Content-Transfer-Encoding &optional default-encoding ¶

現在の buffer の Content-Transfer-Encoding 欄を読み取り、解析した結果を 返す。

Content-Transfer-Encoding 欄が存在しない場合はdefault-encoding を 返す。

6.2 符号化・復号化 ¶

Function: mime-encode-region start end encoding ¶

現在の buffer の start から end までの region を encoding を使って符号化します。

Function: mime-decode-region start end encoding ¶

現在の buffer の start から end までの region を encoding を使って復号化します。

Function: mime-decode-string string encoding ¶

string を encoding として復号した結果を返す。

Function: mime-insert-encoded-file filename encoding ¶

ENCODING format で符号化された file FILENAME を 挿入する。

Function: mime-write-decoded-region start end filename encoding ¶

encoding で符号化された現在の region を復号化して filenameに書き込みます。

<var>start<var> と end は buffer の位置です。

6.3 Other utilities ¶

Function: mime-encoding-list &optional SERVICE ¶

Content-Transfer-Encoding の list を返します。

service が指定されていると、それに対する Content-Transfer-Encoding を返します。

Function: mime-encoding-alist &optional SERVICE ¶

補完のための Content-Transfer-Encoding の表を返します。

service が指定されている場合はそれに対する Content-Transfer-Encoding の list を返します。

6.4 How to write encoder/decoder module ¶

Macro: mel-define-method name args &rest body ¶

name を (nth 1 (car (last args))) backend の method 関数として定義します。

args は lambda の引数 list と似ていますが、(car (last args)) は指定された parameter である必要があります。(car (car (last args))) は変数の名前で、(nth 1 (car (last args))) は backend の名前 (encoding) です。

例:

(mel-define-method mime-write-decoded-region (start end filename
						    (nil "base64"))
  "Decode and write current region encoded by base64 into FILENAME.
START and END are buffer positions."
  (interactive
   (list (region-beginning) (region-end)
	 (read-file-name "Write decoded region to file: ")))
  (let ((str (buffer-substring start end)))
    (with-temp-buffer
      (insert (decode-base64-string str))
      (write-region-as-binary (point-min) (point-max) filename)
      )))

Macro: mel-define-method-function spec function ¶

spec の関数定義を function に設定します。

spec の最初の要素は service です。

args の残りは lambda の引数 list 似ていますが、(car (last args)) は指定された parameter である必要があります。(car (car (last args))) は変数の名前で、(nth 1 (car (last args))) は backend の名前 (encoding) です。

例:

(mel-define-method-function (mime-encode-string string (nil "base64"))
			    'encode-base64-string)

6.5 符号化/復号化 service を追加する方法 ¶

Macro: mel-define-service name &optional args doc-string ¶

name を Content-Transfer-Encoding の service として定義しま す。

args が指定されていると、name は service の generic function として定義されます。

例:

(mel-define-service encoded-text-encode-string (string encoding)
  "Encode STRING as encoded-text using ENCODING.
ENCODING must be string.")

7.1 Header の符号化・復号化 ¶

Function: eword-decode-header &optional code-conversion separator ¶

Header 中の encoded-word を復号する。

もし code-conversion が nil なら、encoded-word だけが復号さ れる。もし、code-conversion が MIME charset (MIME charset) なら、非 ASCII bit patterns はその MIME charset として復号される。これ以 外の場合、非 ASCII bit patterns はdefault-mime-charset. として復 号される。(cf. Entity の文字表現)

もし separator が nil でなければ、その値がheader separator として用いられる。

Function: eword-encode-header &optional code-conversion ¶

Header を network 表現に符号化する。

各 field は mime-field-encoding-method-alist で指定された方式で 符号化される。

Variable: mime-field-encoding-method-alist ¶

Field を符号化する方法を指定する連想 list。各 element は (FIELD . METHOD) の様になっている。

METHOD が mime であれば、FIELD は MIME format に符号化さ れる (encoded-word)。

METHOD が nil であれば、FIELD は符号化されない。

METHOD が MIME charset であれば、FIELD はネットワークコードに変換しな ければならないときに charset に符号化される。

そうでなければ、FIELD はネットワークコードに変換しなければならないとき に 変数 default-mime-charset で符号化される

9.1 用語 ¶

• 7bit
• 8bit
• ASCII
• Base64
• binary
• Coded character set（符号化文字集合）, Character code（文字符号）
• media-type
• message
• MIME
• MIME charset
• MTA
• MUA
• Quoted-Printable
• RFC 822
• RFC 1036
• RFC 2045
• RFC 2046
• RFC 2048
• RFC 2049
• plain text
• us-ascii

9.2 bug 報告の仕方 ¶

FLIM-LB に関する議論は以下のメーリングリストで行われます。 最新バージョンのアナウンスもこちらに流れます。

Wanderlust Mailing List <wl@ml.gentei.org>

ここでは主に日本語での議論が行われています。また、英語専用のリストとして

Wanderlust List in English <wl-en@ml.gentei.org>

もあります(こちらに投稿されたメッセージは前者にも配送されます)。

これらのメーリングリストのガイドを得るには、wl-ctl@ml.gentei.org 宛 (英語の方は wl-en-ctl@ml.gentei.org 宛) で、本文に

# guide

と書いたメールを送って下さい。

バグ報告やパッチの送付もこれらのメーリングリストへ送ってください。メーリ ングリストへの送信はメンバになる必要があります。

但し、あまりにも古い版に関する報告は歓迎されません。古い版の bug は、新 しい版では治っているかもしれません。まず、最新版で確認してみましょう。

それから、適切な報告をしましょう。単に「うまく動かない」と言われてもど ういう状況なのかはさっぱり判りません。最低限、OS, emacs, APEL, FLIM, SEMI, 使っている MUA の種類および版、設定を書く必要があります。また、 error が起っている場合は backtrace を送ることも重要です。 (cf. Reporting Bugs in GNU Emacs Manual)

また、bug は大抵複数の人が遭遇するものです（そうでなければ、bug ではな い可能性があります）。だから、作者に直接 mail を送ると作者は同じ mail を何通も書く羽目になります。だから、必ず bug 報告は上記の address に送っ てください。

9.3 GitHub による開発 ¶

FLIM-LB のリポジトリは GitHub で公開されています。

https://github.com/wanderlust/flim

プルリクエストを送る場合は、Emacs の様に、コミットメッセージに従来の ChangeLog エントリに相当する内容をインデントせずに入力して下さい。 Emacs の CONTRIBUTE ファイル ¹ にある Commit messages セクションを参照して下さい。

また、バグ報告の場合はバックトレースを取って添付すると原因究明しやすくな ります。 ²

9.4 歴史 ¶

FLIM の code の最古の部分は 榎並 嗣智 氏が書いた mime.el に起源し ます。この小さな program は Nemacs で動作する iso-2022-jp の B-encoding 専用の encoded-word の復号化プログラムでした。

その後、守岡 知彦 は mime.el を元にtiny-mime.el というプロ グラムを書きます。これは、Nemacs と Mule で動作する encoded-word の符号 化・復号化プログラムでした。tiny-mime.el は B-encoding だけでなく Q-encoding もsupport し、また、MULE で扱うことができるさまざまな MIME charset (MIME charset) を同時に使うことができました。この時、 Nemacs と Mule の双方を support するために用いられたテクニックは後に emu package にまとめられます。

この頃、守岡 知彦 は tiny-mime.el をさまざまな MUA で使うための設 定集も配布していましたが、それらは後にtiny-mime.el とともに１つの package にまとめられ、tm という名前で配布されます。

守岡 知彦 はやがて、MIME message を閲覧するためのプログラムである tm-body.el を書きます。これは、すぐにtm-view.el という名前 に変わりましたが、やがて、これがtiny-mime.el に代わって、tm の中 核となります。

tm-view.el は当然、Content-Transfer-Encoding を扱う必要があります。 この目的のために、MEL が整備されはじめました。Base64 に関しては tiny-mime.el の code が移され、また、新たにQuoted-Printable の code が追加されました。これらがmel-b.el と mel-q.el になり ました。

また、後に、守岡 知彦 によって uuencode 用の mel-u.el が追加され、 その後に、小林 修平 氏によって x-gzip64 用のmel-g.el が追加されま した。

tm では後に、守岡 知彦 によって tiny-mime.el の再実装が行われ、こ の過程で、STD 11 の parser が書かれました。これは、現在の std11.el に当たります。また、この過程で tiny-mime.el は復 号化を行う tm-ew-d.el と符号化を行う tm-ew-e.el に分けられ ました。この両者が現在の eword-decode.el と eword-encode.el の先祖に当たります。

後に、守岡 知彦 らによって tm の全面書き換え作業が行われ、この過程で、tm は APEL, MEL, SEMI, EMH, RMAIL-MIME, Gnus-MIME などに分けられました。こ のうちの MEL が FLIM の直接の先祖に当たります。

後に、APEL から std11.el が移され、また、mailcap.el, eword-decode.el および eword-encode.el が SEMI から移され、 package の名前が FLIM となります。

この直前から田中 哲 氏がより RFC に忠実な実装を書き始め、これは、現在、 FLIM の枝である “FLIM-FLAM” となっています。