Webmail 用 Web API

● Webmail 用 WebAPI (Pro版のみ利用可能)
WebAPI は、Webmail を経由してメールボックス内の情報の取得や操作を行うことができる API です。
API の実行はブラウザ又は http client が操作可能なスクリプト等からご利用頂けます。

利用するにあたっての注意事項。

WebAPI の応答は原則として JSON形式となります。JSON については JSON の紹介等をご参照下さい。
JSON自体の取り扱いについてはサポート外となりますのでご了承下さい。
WebAPI を利用する場合、HTMLの知識が必要となります。
WebAPI を利用する場合、文字コードは UTF-8 で送信する必要があります。特に日本語を扱う場合は注意して下さい。

● Web API の利用準備

サーバーマネージャーの CGI タブから pmum.ini 編集を行って、WebAPI の利用を on にする必要があります。
WebAPI の利用を on にした後に Webmail へログインを行います。
オプションメニューの最後に WebAPI key が表示されていますので、こちらをメモします。

WebAPI の利用が on になっていない場合は表示されません。

● Web API の利用 WebAPI は http の POSTメソッドを利用して実行します。

例）
<form action="./pmum.exe?API" method="post">
<input type="hidden" name="userid" value="userid">
<input type="hidden" name="apikey" value="123456789abcdefg">
<input type="hidden" name="ope" value="list">
<input type="submit" value="done">
</form>

action には Webmail への URL を指定しオプションとして半角英字で大文字の APIを追加します。（？も必要です）
userid には該当するアカウントの ID を指定します。
apikey には、Webmail のオプションメニューに表示されている Webmail API Key を指定します。
ope には処理を行うコードを指定します。
指定する ope によっては追加オプションが必要となります。

● ope 説明
ope に指定できるコマンドは下記の通りです。

list
指定するフォルダのメール一覧を取得します。
メールのファイル名及び、UIDとサイズを出力します。それ以上の情報は取得しませんので軽く動作します。
UIDが空欄で、サイズが -1 の場合は、管理ファイル(uidl.txt)には登録されているが、実ファイルが無い状態です。
追加オプションとして

<input type="hidden" name="folder" value="プライベート">
リストを取得するサブフォルダを指定します。省略した場合は受信メールボックスが対象となります。
listex
指定するフォルダのメール一覧を取得します。
list の情報に加え、メールに添付ファイルがある場合は、添付ファイルを解析して添付ファイルのファイル名、サイズ、SHA1 と SHA256 のハッシュ値の取得も行います。(その為少し処理が重くなります。)
UIDが空欄で、サイズが -1 の場合は、管理ファイル(uidl.txt)には登録されているが、実ファイルが無い状態です。
またメールのヘッダー情報の取得も可能です。
追加オプションとして

<input type="hidden" name="headers" value="Message-ID,Date">
headers はメールヘッダに含まれる各セクションの値を取得することができます。複数のセクションを取得する場合は、カンマで区切って記述します。

<input type="hidden" name="folder" value="プライベート">
リストを取得するサブフォルダを指定します。省略した場合は受信メールボックスが対象となります。
folders
指定するアカウントのサブフォルダ一覧を取得します。
受信メールボックスは INBOX、送信済みメールボックスは SENDED、ごみ箱は TRASH となります。

ただし、受信メールボックスを指定する場合は、INBOX では無く、空欄を指定して下さい。
また取得されたリストは階層化されておりません。
move
指定するアカウントのメールを別のフォルダへ移動します。

<input type="hidden" name="uid" value="123456abde789">
削除対象のメールの UID を指定します。複数の UID を指定する場合は、カンマで区切ります。
UID の取得は list / listex で行うことができます。

<input type="hidden" name="folder" value="プライベート">
移動元になる eml ファイルがあるフォルダを指定します。省略した場合は受信メールボックスが対象となります。

<input type="hidden" name="dest" value="プライベート">
移動先になる eml ファイルがあるフォルダを指定します。省略した場合は受信メールボックスが対象となります。
delete
指定するアカウントのメールを削除します。

<input type="hidden" name="uid" value="123456abde789">
削除対象のメールの UID を指定します。複数の UID を指定する場合は、カンマで区切ります。
UID の取得は list / listex で行うことができます。

<input type="hidden" name="folder" value="プライベート">
リストを取得するサブフォルダを指定します。省略した場合は受信メールボックスが対象となります。

●応答
WebAPI を実行した応答は JSON形式で出力されます。
基本応答として

status
status は API の実行結果が出力されます。
- success : 成功しました。
- api disable : WebAPI の利用許可がされていません。
- login faild : userid と APIKey が一致しません。
- illigal ope code : 実行できない ope が指定されました。
- illigal option : 指定されたオプションが不正又は誤りがあります。
- I/O error : 指定されたファイル又は管理ファイルがオープンできません。。
- config faild : pmum.ini が読み込めない等のエラーが発生しました。
- move faild : move で指定されたフォルダが不正又は同じフォルダが指定されています。
opedate
WebAPI が実行されたサーバー上の時間が出力されます。
ope
実行された ope が入ります。
Web API を応答を待たずに実行をした場合、サーバー側での処理が完了した順番で応答が返ります。この場合、結果が前後する場合がありますので、必要に応じてご利用下さい。