imap_savebody

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

    imap_savebody — Save a specific body section to a file

    Description

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

    Saves a part or the whole body of the specified message.

    Parameters

    imap

    An IMAP\Connection instance.

    file

    The path to the saved file as a string, or a valid file descriptor returned by fopen().

    message_num

    The message number

    section

    The part number. It is a string of integers delimited by period which index into a body part list as per the IMAP4 specification

    flags

    A bitmask with one or more of the following:

    • FT_UID - The message_num is a UID
    • FT_PEEK - Do not set the \Seen flag if not already set
    • FT_INTERNAL - The return string is in internal format, will not canonicalize to CRLF.

    Return Values

    Returns true on success or false on failure.

    Changelog

    Version Description
    8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap resource was expected.

    See Also

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 3 notes

    up
    13
    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.
    up
    -3
    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);
    ?>
    up
    -5
    technocraze at gmail dot com
    16 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
    ＋add a note
    To Top