IMAP_Download

4D Internet Commands v15

IMAP_Download


IMAP_Download ( imap_ID ; msgNum ; headerOnly ; fileName ; updateSeen ) -> 戻り値

引数	型	説明
imap_ID	倍長整数	IMAPログイン参照
msgNum	倍長整数	メッセージ番号
headerOnly	整数	0 = メッセージ全体, 1 = ヘッダのみ
fileName	テキスト	ローカルファイル名
		実際のローカルファイル名
updateSeen	整数	0 = \Seen フラグを追加; 1= \Seen フラグを追加しない
戻り値	整数	エラーコード

説明

IMAP_Download コマンドは、IMAPサーバからメッセージをディスク上のファイルとして取得するために使用します。添付ファイルが含まれるメッセージやサイズが32Kを超えるIMAPメッセージは、このコマンドを使用してダウンロードすべきです。添付ファイルはこの方法でダウンロードされたメッセージからのみ取り出せます。

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

msgNum はメールボックス中の取り出すメッセージを指定するメッセージ番号です。msgNum は現在処理対象のメールボックス中のすべてのメッセージにおける、メッセージの位置を表します。特定のメッセージのメッセージ番号がセッションをまたいで同一であるとは限りません。

headerOnly は、メッセージ全体をダウンロードするかヘッダのみをダウンロードするかを指定する整数値です。

fileName には、メッセージを保存する際に使用するファイル名と、そのパスを渡します。この値は以下の三つの方法で指定できます:

"": IMAP_SetPrefsで設定したフォルダに、“temp1” (同じ名前のファイルが存在する場合、未使用のファイル名が見つかるまで“temp2”, “temp3”などが試されます) などのファイル名でファイルを保存します。
"FileName": IMAP_SetPrefsで設定したフォルダに、FileNameで保存されます。
"Path:FileName" = FileNameで指定したパスにファイルを保存します。

最初の二つの場合、IMAP_SetPrefsでフォルダが指定されていなければ、ストラクチャと同階層 (4D シングルユーザの場合) または4Dクライアントフォルダ (4D Serverの場合) に保存されます。

ファイルがディスクに保存されると、fileName 引数に渡された変数に最終的なファイル名が返されます。既に存在するファイル名をfileNameに指定してIMAP_Downloadをコールすると、増分された数値がファイル名に付加され、fileName変数に返されます。

updateSeen は\Seenフラグをメッセージに付加するかしないかを指定する整数値です:

0 = \Seen フラグを追加する
1 = \Seen フラグを追加しない

この引数はオプションで、指定しない場合のデフォルト値は0です。

参照

IMAP_GetMessage
IMAP_SetPrefs