Home/ Manual/ imap / functions/ imap_savebody

imap_savebody

PHP function Edit on GitHub ✎

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

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.

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.

Success

Version	Description