IMAP_GetMessage

version 6.8.1

IMAP_GetMessage (imap_ID; msgNum; offset; length; msgPart; msgText{; updateSeen}) --> 整数

IMAP_GetMessage コマンドは、IMAP_SetCurrentMBで参照されるカレントのメールボックス中、msgNumで指定したメッセージの完全なテキストを返します。IMAP_SetPrefsで指定しない限り、メッセージ中のラインフィードは取り除かれます。

IMAP_GetMessage コマンドはmsgPart引数の指定に基づき、メッセージ全体、ヘッダのみ、あるいはボディのみを返します。

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

msgNum は受信するメッセージを指定するメッセージ番号です。この番号はカレントのメッセージリスト中の位置を表します。セッションをまたいだ場合、この番号は特定のメッセージに対して変わることがあります。

offsetは、msgPartで指定したパートで、読み込みを開始する文字位置を表す数値です。

lengthはoffset位置からの読み込む文字数を指定する数値です。この数値は32,000以下でなければなりません。msgPartのサイズが32Kを超える場合、メッセージはIMAP_Download コマンドを使用してディスクに保存します。

msgPartは受信するメッセージのパートを指定します:

・0 = メッセージ全体

・1 = ヘッダのみ

・2 = ボディのみ (最初のtext/plainが見つかったところ)

メッセージ全体またはヘッダのみを取得した場合、デコードは行いません。他方、ボディのみを取得した場合、必要に応じてテキストはデコードされ変換されます (デコードと変換のルールについてはPOP3_Charsetの説明を参照)。

updateSeen はメッセージに\Seenフラグを追加するかどうかを指定します。この引数はオプションで、指定しない場合デフォルト値が使用されます。

・0 = \Seenフラグを追加 (デフォルト)

・1= \Seenフラグを追加しない

msgTextには受信したテキストが変えされます。

IMAP_Download, IMAP_Login, IMAP_SetCurrentMB, IMAP_SetPrefs.