imap_savebody

(PHP 5 >= 5.1.3, PHP 7, PHP 8)

imap_savebody指定した本文部をファイルに保存する

説明

imap_savebody ( resource $imap , resource|string|int $file , int $message_num , string $section = "" , int $flags = 0 ) : bool

指定したメッセージの本文全体、あるいはその一部を保存します。

パラメータ

imap

imap_open() が返す IMAP ストリーム。

file

保存先ファイルへのパスを表す文字列、あるいは fopen() が返すファイル記述子。

message_num

メッセージ番号。

section

パート番号。ピリオドで区切られた整数文字列を指定します。 これは、IMAP4 仕様における本文パートのリストへのインデックスとなります。

flags

ビットマスクであり、以下の組合わせとなります。

  • FT_UID - message_numは UID である
  • FT_PEEK - 既に設定されていない場合、 \Seen フラグを設定しない
  • FT_INTERNAL - 内部フォーマットで文字列を返す。CRLF に正規化しない。

返り値

成功した場合に true を、失敗した場合に false を返します。

参考

  • imap_fetchbody() - メッセージ本文中の特定のセクションを取り出す