---------------------------------------------------------------------------
SIMAP4 README.ja
---------------------------------------------------------------------------
simap4.el --- A simple IMAP4 (RFC 2060) protocol driver module
simap4-console.el --- An Emacs mode to intractively examine IMAP server.
---------------------------------------------------------------------------

概略
----

simap4.el は Emacs のプログラムから IMAP4 (RFC 2060) のサーバと接続し
て通信するためのライブラリです。Emacs 上で動作する MUA から使用するこ
とを想定しています。デフォルトの認証のみをサポートし、RFC 2060 で定義
されている IMAP4 のコマンドとレスポンスを Emacs lisp で扱いやすい形に
変換するだけのライブラリです。

simap4-console.el は Emacs 上で動作する simap4.el を使用してサーバにア
クセスできる簡単なコマンドライン形式のユーザインタフェースです。おもに
simap4.el のデバッグを目的としています。


インストール
------------

ファイルが少ないので手動でインストールするのが速いです。site-lisp の下
に simap4 等、適当なディレクトリを作り、そこに simap4.el をコピーして
ください。コンパイルは DIRED mode から "B" (dired-do-byte-compile) と
するのが一番簡単です。simap4-control.el は必要な方のみ simap4.el と同
様にインストールしてください。

一応 make (Unix系) または makeit.bat (Windows系) でコンパイルインストー
ルすることもできます。make の場合 Makefile の EMACS および INSTALLDIR 
を環境にあわせて書き換え make install を実行します。 makeit.bat の場合
makeit.bat を %HOME%/.elispmk などにコピーし、必要な環境変数(PREFIX,
EMACS, EXEC_PREFIX, LISPDIR, INFODIR, VERSION_SPECIFIC_LISPDIR )を設定
したあと./makeit.bat install を実行します。makeit.bat のファイルの先頭
にもう少し詳しい説明があるので参照してください。


使用法
------

simap4.el 自体はライブラリなので特に使用法はありません。定義されている
関数の詳細については、simap4.el と RFC 2060 を読んでください。


simap4-console.el は、まずロードして M-x simap4-console を実行します。
始めにサーバの名前を尋ねて来ますので入力します。もし、そのサーバが既に
オープンされている場合ここでコマンドモードに入ります。そうでなければ、
ログイン名とパスワードを訊いて来ますので入力します。この時点でコマンド
モードに入ります。

次のようなバッファが表示されます。

  -- SIMAP4 Console -- type help for usage.
  SIMAP4> 


SIMAP4> のプロンプトで IMAP4 のコマンドを実行し、その結果を表示するこ
とができます。

コマンドの例:
  SIMAP4> connect
  SIMAP4> login
  SIMAP4> list "\"\"" "*"
  SIMAP4> select inbox
  SIMAP4> search "all"

IMAP4 プロトコルに関連するコマンド以外に help, print, showbuf 等のコマ
ンドがあります。help は、コマンドリスト、もしくは IMAP4 コマンドを指定
して説明を表示することができます。print は IMAP4 接続についてのいろい
ろな状態を表示するのに使用します。showbuf は IMAP4 通信に使用されるプ
ロセスバッファを別 window に表示するのに使用します。

以下は既に接続されている IMAP4 セッションを simap4-console を使用して
モニターした時のログです。別 frame 内で MUA を利用しながら動作を確認す
ると便利です。

-----------------------------------------------------------------------------
-- SIMAP4 Console -- type help for usage.
SIMAP4> showbuf
SIMAP4> expunge
proc: imap4
selected-mailbox: inbox
state: selected
last-command-string: expunge
last-command-start: 527
last-command-end: 564
last-command-result: OK
last-command-explanation: Completed
resp-exists: 5
resp-recent: 0
resp-expunge: (6)
SIMAP4> check
proc: imap4
selected-mailbox: inbox
state: selected
last-command-string: check
last-command-start: 588
last-command-end: 588
last-command-result: OK
last-command-explanation: Completed
SIMAP4> check
proc: imap4
selected-mailbox: inbox
state: selected
last-command-string: check
last-command-start: 636
last-command-end: 660
last-command-result: OK
last-command-explanation: Completed
resp-exists: 6
resp-recent: 1
SIMAP4> print resp
resp-ok: nil
resp-no: nil
resp-bad: nil
resp-preauth: nil
resp-bye: nil
resp-capability: nil
resp-list: nil
resp-lsub: nil
resp-status: nil
resp-search: nil
resp-exists: nil
resp-recent: nil
resp-expunge: nil
resp-fetch: nil
SIMAP4> expunge
proc: imap4
selected-mailbox: inbox
state: selected
last-command-string: expunge
last-command-start: 12241
last-command-end: 12343
last-command-result: OK
last-command-explanation: Completed
resp-exists: 0
resp-recent: 0
resp-expunge: (1 1 1 1 1 1)
SIMAP4> 
-----------------------------------------------------------------------------
