imap_body
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_body — Read the message body
Description
imap_body() returns the body of the message,
numbered message_num in the current
mailbox.
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
flagsare a bit mask with one or more of the following:-
FT_UID- Themessage_numis 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 the body of the specified message, as a string, or false on failure.
Changelog
| Version | Description |
|---|---|
| 8.1.0 |
The imap parameter expects an IMAP\Connection
instance now; previously, a resource was expected.
|
Here you can write a comment
There are no comments available yet.
