version 6.5
POP3_MsgLstInfo (pop3_ID; startMsg; endMsg; sizeArray; msgNumArray; idArray) --> 整数
引数 | タイプ | 説明 | |
pop3_ID | 倍長整数 | --> | POP3ログイン参照 |
startMsg | 倍長整数 | --> | 開始メッセージ番号 |
endMsg | 倍長整数 | --> | 終了メッセージ番号 |
sizeArray | 倍長整数配列 | サイズ配列 | |
msgNumArray | 倍長整数配列 | メッセージ番号配列 | |
idArray | 文字|テキスト配列 | ユニークID配列 | |
戻り値 | 整数 | エラーコード |
説明
POP3_MsgLstInfo コマンドは、メールボックス中のメッセージの情報を返します。情報は三つの配列に返され、配列のそれぞれの要素が一つのメッセージ対応します。それぞれのメッセージサイズ、メッセージ番号、ユニークIDが返されます。配列は事前に定義されていなければなりません。POP3_MsgLstInfo コマンドは配列のサイズを受信したメッセージ数にリセットします。
POP3_MsgLstInfo コマンドは、現在のメッセージリスト中の情報取得に失敗してもエラーを返しません。エラーが発生した場合、配列要素が作成されません。コマンドがそれぞれのメッセージを正しく読み込むと、msgNumArrayには番号が順番通りに格納されます。問題が発生すると、msgNumArrayに格納された数値に抜けが生じます。
pop3_ID はPOP3_Loginで作成される、開かれたセッションの参照です。
startMsg は、情報を取得するメッセージの開始位置を指定するメッセージ番号です。メッセージ番号は、pop3_IDで特定されるメールボックスのすべてのメッセージリスト中で位置を表す数値です。
endMsg は、情報を取得するメッセージの終了位置を指定するメッセージ番号です。メッセージ番号は、pop3_IDで特定されるメールボックスのすべてのメッセージリスト中で位置を表す数値です。
sizeArray は倍長整数配列で、startMsgとendMsgとの間のそれぞれのメッセージサイズを受け取ります。
msgNumArray は倍長整数配列で、startMsgとendMsgとの間のそれぞれのメッセージ番号を受け取ります。
idArray は文字またはテキスト配列で、startMsgとendMsgとの間のそれぞれのメッセージのユニークIDを受け取ります。
Note: POP3_Delete, POP3_MsgLstInfo および POP3_MsgLst コマンドは、startMsgがendMsgより大きくてもエラーを返しません。このような場合、これらのコマンドは何も行いません。
参照