imap_savebody

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

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

説明

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

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

パラメータ

imap

IMAP\Connection クラスのインスタンス。

file

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

message_num

メッセージ番号。

section

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

flags

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

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

戻り値

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

変更履歴

バージョン	説明
8.1.0	引数 `imap` は、IMAP\Connection クラスのインスタンスを期待するようになりました。これより前のバージョンでは、有効な `imap` リソースが期待されていました。

参考

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

add a note

User Contributed Notes 4 notes

down

anon ¶

12 years ago


By using imap_fetchbody() you may run in trouble by using too much memory. Using imap_savebody() may prevent this. 



But the content will be encoded, in other words it is useless. Adding a filter can help here.



<?php

$whandle = fopen('./incomming/tmp.tif','w');



stream_filter_append($whandle, 

   'convert.base64-decode',STREAM_FILTER_WRITE);



imap_savebody ($mbox, $whandle, $i, $partcounter++);



fclose($whandle);

?>



NOTE: To find the proper filter you need to check the encoding given by the structure of the body.

down

-2

janus at forty-seven dot info ¶

15 years ago


It seems that imap_savebody saves attachments with special characters above ascii 127 as quoted printable. 
But if you need it in utf8, you may use the imap_qprint function after the attachment is saved:

<?php
$tFile = "/path/to/attachment";
$tFileOutput="";
$tFileHandle = fopen($tFile, "r");

//get the content of the file into a string
while(!feof($tFileHandle)) 
  $tFileOutput = $tFileOutput . fgets($tFileHandle, 4096);

fclose ($tFileHandle);
            
$tFileHandle = fopen($tFile, "w");
//write the new 8Bit string to the file
fwrite($tFileHandle, imap_qprint($tFileOutput));
fclose ($tFileHandle);
?>

down

-4

technocraze at gmail dot com ¶

17 years ago


I tried to use this function. But it seems it requires php_zip.dll to be load..  i got the php errror like below.

[20-Dec-2007 13:38:17] PHP Warning:  PHP Startup: Unable to load dynamic library './php_zip.dll' - ./php_zip.dll: cannot open shared object file: No such file or directory in Unknown on line 0
[20-Dec-2007 13:38:17] PHP Fatal error:  Call to undefined function imap_savebody() in /opt/oss/share/apache2/htdocs/blogtest/wp-inst/batch/pop3_mail.php on line 153

down

-6

stupergenius at gmail dot com ¶

17 years ago


This function will save ALL information from the email if the part number is left out. Pretty handy for archiving.

add a note