4D Doc Center : IMAP

4D v13.2

IMAP_MsgLst


IMAP_MsgLst ( imap_ID ; startMsg ; endMsg ; msgHeaderArray ; msgNumArray ; msgIdArray ; msgValueArray ) -> 戻り値

引数	型	説明
imap_ID	倍長整数	IMAPログイン参照
startMsg	倍長整数	開始メッセージ番号
endMsg	倍長整数	終了メッセージ番号
msgHeaderArray	文字配列	取り出すヘッダ配列
msgNumArray	倍長整数配列	メッセージ番号配列
msgIdArray	倍長整数配列	ユニークメッセージID配列
msgValueArray	2D文字列配列, 2Dテキスト配列	ヘッダ値の二次元配列
戻り値	整数	エラーコード

説明

IMAP_MsgLst コマンドは、メールボックスの内容の特定の情報を取得するために使用します。このコマンドを使用して、メッセージリストの特定の列をリクエストできます。このコマンドはヘッダの項目値のみを返すことができます。ボディを取得することはできません。必要に応じてヘッダの内容はデコードされ変換されます。 (デコードと変換のルールについてはPOP3_Charsetの説明を参照)。

imap_ID はIMAP_Loginで作成されるIMAPログイン参照です。

startMsg は情報を取得するメッセージリストの開始メッセージ番号です。メッセージ番号は現在処理対象のメールボックス中のすべてのメッセージにおける、メッセージの位置を表します。

endMsg は情報を取得するメッセージリストの終了メッセージ番号です。メッセージ番号は現在処理対象のメールボックス中のすべてのメッセージにおける、メッセージの位置を表します。

Note: IMAP_Delete, IMAP_MsgLstInfo, IMAP_MsgLst, IMAP_SetFlags, IMAP_GetFlags そしてIMAP_CopyToMBコマンドは、startMsgがendMsgよりも大きい場合でもエラーを返しません。この場合、コマンドは何も行いません。

msgHeaderArray は取り出すメールヘッダを指定する文字配列またはテキスト配列です。

msgNumArray は、startMsgからendMsgまでのそれぞれのメッセージ番号を受け取る倍長整数配列です。

msgIdArray は、startMsgからendMsgまでのそれぞれのメッセージユニークIDを受け取る倍長整数配列です。

msgValueArray 二次元配列で、msgHeaderArrayで指定されたヘッダの値を受け取ります。リクエストされたそれぞれのヘッダは、msgValueArrayの一次元目に対応する配列をもちます。

例題

 aHeaders{1}:="Date:"

 aHeaders{2}:="From:"

 aHeaders{3}:="Subject:"

 IMAP_MsgLst(IMAP_ID;vStart;vEnd;aHeaders;aMsgNum;aMsgId;aValues)

aValues{1}{1} は “Thu, 19 November 1998 00:24:02 -0800”
aValues{2}{1} は “Jack@4d.com”
aValues{3}{1} は “Call your wife”

のようになります。

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

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