home *** CD-ROM | disk | FTP | other *** search
/ DOS/V Power Report 2001 December (DVD) / VPR0112A.ISO / OLS / DEN8_131 / Den8_32.1.3.1_Red_L.lzh / den8api.txt < prev    next >
Text File  |  2000-09-10  |  15KB  |  447 lines
  1. 電信八号 API
  2.  
  3. Copyright (C) 1996-1998 ISHIOKA, Takamitsu
  4. Copyright (C) 1999-2000 Den8club (Denpachi Club); KAWASE, Yutaka
  5.  
  6. All Rights Reseved
  7.  
  8. Version 1.0     1996/04/27
  9. Version 1.1     1996/05/27
  10. Version 1.2     1996/07/20
  11. Version 1.3     1996/08/17
  12. Version 1.4     1997/03/09
  13. Version 1.5     1997/05/31
  14. Version 1.6     1997/11/26
  15. Version 1.7     1998/02/08
  16. Version 1.8     1998/04/06
  17. Version 1.9     1998/07/31
  18. Version 2.0     2000/07/10, 9/10
  19.  
  20. ■はじめに
  21.  
  22. デンパチを他のアプリケーションから制御するために、DDE 等によるデンパチサー
  23. バ API を決めました。
  24.  
  25. また、デンパチの機能の一部を他のアプリケーションに代替させることができる
  26. ように、デンパチクライアント API も決める予定です。
  27.  
  28. これらの API を利用して、デンパチを利用する、あるいは、デンパチの使い勝
  29. 手を向上させるアプリケーションを自由に作ってください。
  30.  
  31. API は必要に応じて逐次追加して行きますので、アイデアをお持ちの方はご連絡
  32. ください。
  33.  
  34. デンパチの配布アーカイブファイルに入っている MainFrm.cpp というファイル
  35. は、クライアント（デンパチにコマンドを送るアプリ）のサンプルで、原作者が
  36. 実験のために作成したプログラムのソースの一部です。
  37.  
  38.  
  39. ■サーバ API
  40.  
  41. 他のアプリケーションからデンパチを制御したり、デンパチの機能を利用してデー
  42. タを取得したりするための API です。
  43.  
  44. ● WM_DDE_EXECUTE
  45.  
  46. ------------------------------------------------------------------------
  47. サービス名    Den8
  48. トピック名    Command
  49. ------------------------------------------------------------------------
  50.  
  51. 注：以下の説明の中で「フォルダ」というのは、Windows のフォルダのことでな
  52.     く、デンパチのフォルダ (*.fld, *.can) を意味します。
  53.     アプリケーション定義返却値は、０が成功をあらわします。
  54.  
  55. Version 1.0
  56. ------------------------------------------------------------------------
  57. コマンド名    Update
  58. 引数１        フォルダのフルパス。
  59. 引数２～ｎ    メールファイル名の拡張子を取り除いたもの、つまり、４桁の数字。
  60.             複数個指定する場合は、昇順に並べなければならない。
  61. 動作        指定したフォルダの指定したメールを読み込み、表示を更新する。
  62.             引数が一個なら、そのフォルダに対して「最新の情報に更新」を行
  63.             ない、かつアクティブにする。
  64. 例            [Update("c:\Share\Den8\In.fld",0147,0258,0369)]
  65. ------------------------------------------------------------------------
  66.  
  67. Version 1.1
  68. ------------------------------------------------------------------------
  69. コマンド名    Select
  70. 引数１        フォルダのフルパス。
  71. 引数２～ｎ    メールファイル名の拡張子を取り除いたもの、つまり、４桁の数字。
  72.             複数個指定する場合は、昇順に並べなければならない。
  73. 動作        指定したフォルダをアクティブにし、アイコン化されていれば復元
  74.             する。更に、そのフォルダのメールの選択状態をいったんクリアし、
  75.             引数２以降があれば、それらのメールを選択する。
  76. 例            [Select("c:\Share\Den8\OUT.FLD",0147,0258,0369)]
  77. ------------------------------------------------------------------------
  78.  
  79. Version 1.1
  80. ------------------------------------------------------------------------
  81. コマンド名    Move
  82. 引数１        移動先フォルダのフルパス。
  83. 引数２        移動元フォルダのフルパス。
  84. 引数３～ｎ    メールファイル名の拡張子を取り除いたもの、つまり、４桁の数字。
  85. 動作        引数２のフォルダにある３～ｎのメールを、引数１のフォルダに移
  86.             動する。
  87. 例            [Move("c:\Den8\TRASH.CAN","c:\Den8\IN.FLD",0012,0013)]
  88. ------------------------------------------------------------------------
  89.  
  90. Version 1.1（Version 1.8 で引数３をオプショナルにした）
  91. ------------------------------------------------------------------------
  92. コマンド名    Reply
  93. 引数１        返信対象メールを含むフォルダのフルパス。
  94. 引数２        返信対象メールファイル名の拡張子を取り除いたもの、つまり、４
  95.             桁の数字。
  96. 引数３        返信用原稿の出力ファイルのフルパス（オプショナル）。
  97. 動作        引数１、２によってあらわされるメールに対する返信の原稿を作成
  98.             し、引数３で指定されるファイルに書き込む。
  99.             引数３が省略されていたら、メール編集用プログラムを呼び出し、
  100.             エディタ終了後に送信動作を起こす。
  101. 例            [Reply("c:\Den8\IN.FLD","8823","c:\Windows\Temp\foo.tmp")]
  102. ------------------------------------------------------------------------
  103.  
  104. Version 1.1
  105. ------------------------------------------------------------------------
  106. コマンド名    Send
  107. 引数１        送信したいメールファイルのフルパス。このファイルの内容は、デ
  108.             ンパチのメールの形式でなければならない。場所はどこでもよく、
  109.             デンパチのフォルダに入っている必要はない。
  110. 動作        メールを解析し、送信先アドレスを抽出して送信の確認を求める。
  111.             その先はデンパチで新規メールを送信する時と同じ。
  112. 例            [Send("c:\Windows\Temp\foo.tmp")]
  113. ------------------------------------------------------------------------
  114.  
  115. Version 1.1
  116. ------------------------------------------------------------------------
  117. コマンド名    Receive
  118. 引数なし
  119. 動作        受信を行なう。
  120. 例            [Receive]
  121. ------------------------------------------------------------------------
  122.  
  123. Version 1.2
  124. ------------------------------------------------------------------------
  125. コマンド名    Focus
  126. 引数１        フォルダのフルパス
  127. 引数２        メールファイル名の拡張子を取り除いたもの、つまり、４桁の数字。
  128. 動作        指定したフォルダをアクティブにし、アイコン化されていれば復元
  129.             する。更に、そのフォルダのメールの選択状態をいったんクリアし、
  130.             引数２があれば、そのメールにキャレットを移動し、かつ選択する。
  131.             そのメールをリスト表示するために、必要ならばスクロールする。
  132. 例            [Focus("c:\Share\Den8\IN.FLD",0147)]
  133. ------------------------------------------------------------------------
  134.  
  135. Version 1.6
  136. ------------------------------------------------------------------------
  137. コマンド名    Realize
  138. 引数１        フォルダのフルパス
  139. 引数２        メールファイル名の拡張子を取り除いたもの、つまり、４桁の数字。
  140. 引数３        出力先ディレクトリのフルパス。
  141. 動作        指定されたフォルダの指定されたメールがマルチパートメッセージ
  142.             ならば、指定されたディレクトリ下にパーツの階層構造を作成する。
  143.             その形式は電信八号がマルチパートメッセージを表示するときに作
  144.             業用に作成しているものと同じ。
  145. 例            [Realize("c:\Share\Den8\IN.FLD",0147,"c:\foo")]
  146. ------------------------------------------------------------------------
  147.  
  148. Version 1.8
  149. ------------------------------------------------------------------------
  150. コマンド名    Attach
  151. 引数１        電八形式のメールファイルのフルパス
  152. 引数２～ｎ    添付したいファイルのフルパス
  153. 動作        引数１で指定されたメールファイルに２～ｎで指定されたファイル
  154.             を Base64 エンコードして添付する
  155. 例            [Attach("c:\Temp\_den0000.tmp","c:\foo\bar.zip")]
  156. ------------------------------------------------------------------------
  157.  
  158. Version 1.8（Version 2.0 で First, Last, ４桁の数字を使えるようにした）
  159. ------------------------------------------------------------------------
  160. コマンド    View    (形式１)
  161. 引数１        次の文字列のうちどれか一つ
  162.                 Prev
  163.                 Next
  164.                 PrevRecv
  165.                 NextRecv
  166.                 First
  167.                 Last
  168.                 メールファイル名の拡張子を取り除いたもの、つまり、４桁の数字。
  169. 動作        現在アクティブなフォルダでフォーカスされているメールの、
  170.                 一つ前のメール (Prev)
  171.                 一つ後のメール (Next)
  172.                 一つ前の未読メール (PrevRecv)
  173.                 一つ後の未読メール (NextRecv)
  174.                 フォルダ内の最初のメール (First)
  175.                 フォルダ内の最後のメール (Last)
  176.                 そのメール (４桁の数字)
  177.             を表示する。
  178. 例            [View("NextRecv")]
  179. 注            「表示」はデンパチ側でダブルクリックする場合と同じ処理を行う。
  180.             従って、同じビューワーを複数個起動されたくない場合は、ビュー
  181.             ワ側が、system トピックの open コマンドなどのサーバー機能を
  182.             持つ必要がある。詳細は後述の「クライアント API」を参照。
  183. ------------------------------------------------------------------------
  184.  
  185. Version 2.0
  186. ------------------------------------------------------------------------
  187. コマンド    View    (形式２)
  188. 引数１        フォルダのフルパス
  189. 引数２        View コマンド (形式１) の引数１と同じ
  190. 動作        引数１で指定したフォルダをアクティブにし、アイコン化されて
  191.             いれば復元し、引数２で指定したメールを表示する。
  192. 例            [View("c:\Den8\IN.FLD","Last")]
  193. ------------------------------------------------------------------------
  194.  
  195. Version 1.8
  196. ------------------------------------------------------------------------
  197. コマンド名    Forward
  198. 引数１        転送対象メールを含むフォルダのフルパス。
  199. 引数２        転送対象メールファイル名の拡張子を取り除いたもの、つまり、４
  200.             桁の数字。
  201. 動作        引数１、２によってあらわされるメールに対する転送の原稿を作成
  202.             し、メール編集用プログラムを呼び出し、エディタ終了後に送信動
  203.             作を起こす。
  204. 例            [Forward("c:\Den8\IN.FLD","8823")]
  205. ------------------------------------------------------------------------
  206.  
  207.  
  208. ------------------------------------------------------------------------
  209. サービス名    Alias    (サーバーは Alias.exe）
  210. トピック名    system
  211. ------------------------------------------------------------------------
  212.  
  213. Version 1.7
  214. ------------------------------------------------------------------------
  215. コマンド名    Append
  216. 引数１～ｎ    メールアドレス
  217. 動作        RootAlias の直下に、指定されたメールアドレスを登録する。
  218. 例            [Append("ishioka@tky.3web.ne.jp")]
  219. 備考        サーバーを起動するには、Alias.exe の場所および住所録ファイル
  220.             の名前を知る必要があります。これらの情報は、denshin8.ini の
  221.             [Global Parameters]セクションの AliasEditor エントリーおよび
  222.             AliasFile エントリーから取得できます。
  223.             denshin8.ini の場所は、常に denshin8.exe の場所と同じです。
  224. ------------------------------------------------------------------------
  225.  
  226. ● WM_DDE_POKE
  227.  
  228. ------------------------------------------------------------------------
  229. サービス名    Den8
  230. トピック名    Command
  231. ------------------------------------------------------------------------
  232.  
  233. Version 1.3
  234. ------------------------------------------------------------------------
  235. アイテム名    Headers
  236. データ形式    CF_TEXT
  237.  
  238.             Toの値 \0 Ccの値 \0 Bccの値 \0 Subjectの値 \0 転送メール \0
  239.  
  240.             ToやCcの値を複数ならべる場合はカンマで連結
  241.  
  242.             <転送メール>というのは、そのアドレスへ転送したいメールのパス。
  243.             新規作成の場合は "New"
  244. ------------------------------------------------------------------------
  245.  
  246.  
  247. 上記以外に、システムトピックで、open コマンドを受け付けます。
  248. open の引数には、起動時のコマンドライン引数と同じものを指定可能です。
  249.  
  250. ------------------------------------------------------------------------
  251. サービス名    DENSHIN8
  252. トピック名    system
  253. ------------------------------------------------------------------------
  254.  
  255. ------------------------------------------------------------------------
  256. コマンド名    open
  257. 引数        コマンドライン引数と同じ
  258. 動作        コマンドライン引数と同じ
  259. 例            [open(-receive)]
  260. 例            [open("c:\boo\foo.fld")]
  261. ------------------------------------------------------------------------
  262.  
  263.  
  264. ■クライアント API
  265.  
  266. 電信八号がクライアント側になる DDE 通信の仕様です。
  267.  
  268. ●WM_DDE_EXECUTE
  269.  
  270. ------------------------------------------------------------------------
  271. サービス名    [サーバに依存しない設定]の[メール表示用プログラム]に書かれた
  272.             コマンドラインの実行モジュール名。たとえば RE8
  273. トピック名    system
  274. ------------------------------------------------------------------------
  275.  
  276. Version 1.1（昔からあるのですがドキュメント化を忘れていました）
  277. ------------------------------------------------------------------------
  278. コマンド名    [サーバに依存しない設定]の[メール表示用プログラム]の[DDE]の
  279.             ところに描かれた文字列。例えば open。
  280. 引数１        メールファイルのフルパス
  281. 動作        そのファイルを表示する
  282. 例            [open("C:\Den8\IN.FLD\0000.txt")]
  283. ------------------------------------------------------------------------
  284.  
  285.  
  286. ■コマンドラインオプション
  287.  
  288. 「組み合わせ不能」と明示されているもの以外は、任意のオプションを組み合わ
  289. せることができます。
  290.  
  291. Version 1.1
  292.  
  293. ・宛先を指定しての起動
  294.  
  295.     denshin8.exe -mailto <address>
  296.  
  297.     例）denshin8.exe -mailto ishioka@tky.3web.ne.jp
  298.  
  299.     起動し、<address> を To: に埋め込んでエディタを立ち上げる。
  300.  
  301.     -receive とは組み合わせ不能
  302.  
  303.  
  304. ・フォルダ状態の復元を行なわない
  305.  
  306.     denshin8.exe -norestore
  307.  
  308.     ２つ目以降のインスタンスでは無効
  309.  
  310.  
  311. ・起動後自動的に受信する
  312.  
  313.     denshin8.exe -receive
  314.  
  315.  
  316. ・アイドル状態になると自動的に終了する
  317.  
  318.     denshin8.exe -quitonidle
  319.  
  320.     -mailto とは組み合わせ不能
  321.  
  322.     ２つ目以降のインスタンスでは無効
  323.  
  324.  
  325. Version 1.5
  326.  
  327. ・起動後新規作成（後、送信）動作を起こす
  328.  
  329.     denshin8.exe -new [<file> ...]
  330.  
  331.     例）denshin8.exe -new attachment="c:\temp\boo.gif" attachment="c:\temp\foo.dcr" inline="c:\temp\woo.html"
  332.  
  333.     <file> は再生方法の指定と添付ファイルのパスを = で結合したもの。
  334.  
  335.     再生方法の指定は、attachment または inline 。
  336.  
  337.     attachment はファイルにセーブする指定（ただし、実際にどのような動作
  338.     になるかは相手側メールソフトの種類と設定に依存するかも）。
  339.  
  340.     inline はその場で実行（表示）する指定（ただし、以下同文）。
  341.  
  342.     添付は引数で与えられた順序で行われる。
  343.  
  344.     他のコマンドラインオプションとは組み合わせ不能。
  345.  
  346. Version 1.9  (本体 V321.2b6)
  347.  
  348. ・起動後自動的にすべての未送信メールを送信する
  349.  
  350.     denshin8.exe -send
  351.  
  352.     巡回先に指定された最初のサーバーへ送信する。巡回先の指定がなければ、
  353.     現在のサーバーを使う。
  354.  
  355. Version 2.0  (本体 V32.1.3.0)
  356.  
  357. ・マルチユーザレベルを指定する
  358.  
  359.     denshin8.exe (-|/)mu[ltiuser]:<level>    (mu まで部分記述すれば有効となる)
  360.     den8_mu<level>.exe    (denshin8.exe をリネームして mu<数字> を含める)
  361.  
  362.     例）denshin8.exe -mu:2 または den8_mu2.exe
  363.  
  364.     <level> は、0, 1 または 2 。 3 以上は現在 2 と同じ。
  365.     0 は、従来と同じ。(１台のパソコンに人数分インストールする)
  366.     1 は、電八の実行ファイル名の .exe を .ini に置き換えた設定ファイルを
  367.     　　　環境変数 DEN8HOME または HOME に書かれたディレクトリにあるとみ
  368.     　　　なす。該当環境変数がないか、値が . (ピリオド)なら従来と同じ。
  369.     2 は、その他のファイル/フォルダの基準ディレクトリも環境変数 DEN8HOME
  370.     　　　または HOME に書かれたディレクトリであるとみなす。以下同上。
  371.  
  372.     DEN8HOME と HOME 両方設定されている場合は、DEN8HOME が優先される。
  373.  
  374.  
  375. ■他のアプリとの連携に関するその他の情報
  376.  
  377. Version 1.1
  378.  
  379. ・メインウィンドウハンドルの取得
  380.  
  381.     クラス名    "DeN8:MaIn"
  382.  
  383.  
  384. Version 1.4
  385.  
  386. ・キャッシュ (*.fld) の形式
  387.  
  388. 先頭がキャッシュヘッダ（フォルダに関する情報を格納する部分）で、その後ろ
  389. にそのフォルダの最大のメール番号 + 1 個のレコードが続きます。
  390.  
  391. つまり、n 番のメールのキャッシュレコードの位置は、次の式で与えられます。
  392.  
  393. sizeof(CACHE_HEADER) + sizeof(CACHE_RECORD) * n
  394.  
  395. 欠けた番号（メールが存在しない番号）のレコードは、status の値が NONE と
  396. なっていることにより識別します。
  397.  
  398. // キャッシュヘッダ
  399. typedef struct {
  400.     char    cIdentifier[64];    // "Den8 Cache Format 3.01"
  401.     BOOL    bDirty;             // 正常にセーブされていない印
  402.     BOOL    bOutFolder;
  403.     BYTE    bSortByDate;
  404.     BYTE    bSortByFrom;
  405.     BYTE    bSortBySubject;
  406.     BYTE    bReverseOrder;
  407.     int     nUnreadCount;
  408.     int     nCaretIndex;
  409.     int     nTopIndex;
  410.     char    cPadding[40];
  411. }    CACHE_HEADER;
  412.  
  413. BOOL           4 バイト
  414. BYTE           1 バイト
  415. int            4 バイト
  416. ヘッダの合計 128 バイト
  417.  
  418. // キャッシュレコード
  419. typedef struct {
  420.     STATUS    status;         // X-Status
  421.     time_t    timeDate;        // 日付時刻
  422.     int     nSize;            // メールサイズ
  423.     char    cHeader [500];    // 文字列情報
  424. }    CACHE_RECORD;
  425.  
  426. // cHeader の中身
  427. // <FROM/TO>\0<MESSAGE-ID>\0<IN-REPLY-TO>\0<SUBJECT>\0<body-head>\0
  428.  
  429. // ステータス
  430. typedef enum {
  431.     NONE = 0,
  432.     RECV = 1,
  433.     READ = 2,
  434.     RPLY = 3,
  435.     RPLD = 4,
  436.     WRIT = 5,
  437.     SENT = 6,
  438.     ERRR = 7
  439. }    STATUS;
  440.  
  441. STATUS                       4 バイト
  442. time_t                       4 バイト
  443. キャッシュレコードの合計 512 バイト
  444.  
  445. ※　STATUS は現在も 4 バイト(リトルエンディアン)だが、将来の拡張を見越して
  446. 　　最初(下位)の 1 バイト以外はマスクして判定することを推奨する。
  447.