PHP: imap_body - Manual (original) (raw)

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_body — Read the message body

Description

imap_body() will only return a verbatim copy of the message body. To extract single parts of a multipart MIME-encoded message you have to use imap_fetchstructure() to analyze its structure and imap_fetchbody() to extract a copy of a single body component.

Parameters

imap

An IMAP\Connection instance.

message_num

The message number

flags

The optional flags are a bit mask with one or more of the following:

• [FT_UID](imap.constants.php#constant.ft-uid) - The message_num is a UID
• [FT_PEEK](imap.constants.php#constant.ft-peek) - Do not set the \Seen flag if not already set
• [FT_INTERNAL](imap.constants.php#constant.ft-internal) - The return string is in internal format, will not canonicalize to CRLF.

Return Values

Returns the body of the specified message, as a string, or [false](reserved.constants.php#constant.false) on failure.

Changelog