4D Doc Center : IMAP

4D Internet Commands v14

IMAP_GetFlags


IMAP_GetFlags ( imap_ID ; startMsg ; endMsg ; msgFlagsArray ; msgNumArray ) -> 戻り値

引数	型	説明
imap_ID	倍長整数	IMAPログイン参照
startMsg	テキスト	開始メッセージ番号
endMsg	テキスト	終了メッセージ番号
msgFlagsArray	文字配列	メッセージ毎のフラグ値
msgNumArray	倍長整数配列	メッセージ番号の配列
戻り値	整数	エラーコード

説明

IMAP_GetFlags コマンドは指定したメッセージのフラグリストを返します。

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

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

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

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

msgFlagsArray はテキスト配列で、startMsgからendMsgの間のメッセージのフラグリスト (空白区切り) が返されます。

msgNumArray 倍長整数配列で、startMsgからendMsgの間のメッセージ番号が返されます。