|
|
|
|
|
|
|
|
|
|
version 6.8.1
IMAP_MsgLstInfo (imap_ID; startMsg; endMsg; msgSizeArray; msgNumArray; msgIdArray) --> 整数
| 引数 | タイプ | 説明 | |
| imap_ID | 倍長整数 | --> | IMAPログイン参照 |
| startMsg | 倍長整数 | --> | 開始メッセージ番号 |
| endMsg | 倍長整数 | --> | 終了メッセージ番号 |
| msgSizeArray | 倍長整数配列 |  | サイズ配列 |
| msgNumArray | 倍長整数配列 | | メッセージ番号配列 |
| msgIdArray | 倍長整数配列 | | ユニークメッセージID配列 |
| 戻り値 | 整数 | | エラーコード |
説明
IMAP_MsgLstInfo コマンドは (IMAP_SetCurrentMB コマンドで指定された) 現在処理対象のメールボックスの、一連のメッセージに関する情報を返します。情報は三つの配列に返され、配列のそれぞれの要素は一つのメッセージに対応します。メッセージサイズや番号に関する情報が返されます。配列は事前に定義されていなければなりません。IMAP_MsgLstInfo コマンドはそれぞれの配列サイズをメッセージ数にリセットします。
IMAP_MsgLstInfo コマンドは、カレントのメッセージリスト中のメッセージの取得に失敗しても、エラーは返しません。エラーが発生すると、そのメッセージの配列要素は作成されません。コマンドがメッセージを読み込むと、msgNumArrayには順番に数値が格納されます。問題があった場合には、msgNumArray配列に格納された数値に抜けが生じます。
imap_ID はIMAP_Loginで作成されるIMAPログイン参照です。
startMsg は情報を取得するメッセージリストの開始メッセージ番号です。メッセージ番号は現在処理対象のメールボックス中のすべてのメッセージにおける、メッセージの位置を表します。
endMsg は情報を取得するメッセージリストの終了メッセージ番号です。メッセージ番号は現在処理対象のメールボックス中のすべてのメッセージにおける、メッセージの位置を表します。
Note: IMAP_Delete, IMAP_MsgLstInfo, IMAP_MsgLst, IMAP_SetFlags, IMAP_GetFlags そしてIMAP_CopyToMBコマンドは、startMsgがendMsgよりも大きい場合でもエラーを返しません。この場合、コマンドは何も行いません。
sizeArray は、startMsgからendMsgまでのそれぞれのメッセージサイズを受け取る倍長整数配列です。
msgNumArray は、startMsgからendMsgまでのそれぞれのメッセージ番号を受け取る倍長整数配列です。
msgIdArray は、startMsgからendMsgまでのそれぞれのメッセージユニークIDを受け取る倍長整数配列です。
参照
|
|
|
|
|
|
|
|
|
|