POP3_MsgLst

4D v20

POP3_MsgLst


POP3_MsgLst ( pop3_ID ; start ; end ; hdrArray ; msgNumArray ; idArray ; valueArray ) -> 戻り値

引数	型	説明
pop3_ID	倍長整数	POP3ログイン参照
start	倍長整数	開始メッセージ番号
end	倍長整数	終了メッセージ番号
hdrArray	文字配列	受信するヘッダの配列
msgNumArray	倍長整数配列	メッセージ番号配列
idArray	文字配列	ユニークID配列
valueArray	2D文字列配列, 2Dテキスト配列	ヘッダ値の二次元配列
戻り値	整数	エラーコード

説明

POP3_MsgLst コマンドは、メールボックスの内容の、特定の情報を取得するために使用します。hdrArray は情報を取得したいヘッダを指定する文字列またはテキスト配列です。valueArrayは二次元配列で、hdrArrayで指定したヘッダの情報を受け取ります。リクエストされたそれぞれのヘッダは、valueArrayの一次元目に対応する配列をもちます。

このコマンドを使用して、メッセージリストの特定の列をリクエストできます。このコマンドはヘッダ項目の値のみを返します。メッセージのボディを取得することはできません。

Note: メールヘッダには拡張文字が含まれている場合があるため、POP3_Charset コマンドを使用してそれらの処理を自動化することができます。

例題

 aHeaders{1}:="Date:"

 aHeaders{2}:="From:"

 aHeaders{3}:="Subject:"

 POP3_MsgLst(<>POP3_ID;vStart;vEnd;aHeaders;aMsgNum;aUIDs;aValues)

 aValues{1}{1}may equal"Thu, 19 November 1998 00:24:02 -0800"

 aValues{2}{1}may equal"Jack@4d.com"

 aValues{3}{1}may equal"Call your wife"

エラーは以下のように処理されます:

通信に関連するエラーのみが返されます。コマンドがネットワークやシンタックス、サーバなどのエラーのため正しく実行できなかった場合、対応するエラーコードが返されます。
指定された範囲のメッセージが存在しなかった場合やエラーを受け取った場合、
- そのメッセージの配列要素は作成されません。
- エラーコードは返されません。
指定したヘッダが一部あるいはすべて、メッセージ中で全く見つからなかった場合、エラーは生成されません。
- メッセージの配列要素は作成されます。
- メッセージ番号とユニークID配列の要素には正しい値が返されます。
- メッセージに存在しないヘッダに対しては、配列要素に空の文字列が返されます。
- エラーコードは返されません。

Note: POP3_Delete, POP3_MsgLstInfo および POP3_MsgLst コマンドは、startMsgがendMsgより大きくてもエラーを返しません。このような場合、これらのコマンドは何も行いません。

参照

POP3_Charset
POP3_MsgInfo
POP3_MsgLstInfo