imap_body

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

imap_body — Read the message body

Description

imap_body(IMAP\Connection $imap, int $message_num, int $flags = 0): string|false

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 flags are a bit mask 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 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 valid `imap` resource was expected.

add a note

User Contributed Notes 2 notes

down

theloverkills at gmail dot com ¶

7 years ago


Please note that the UID is NOT unique.
UID of the email may be not unique on the server (2 messages in different folders may have same UID).

Basically, don't use the UID as a unique identifier.

down

deenfirdoush at gmail dot com ¶

15 years ago


Simple example on how to read body message of the recent mail.



<?php

$imap = imap_open("{pop.example.com:995/pop3/ssl/novalidate-cert}", "username", "password");



if( $imap ) {

    

     //Check no.of.msgs

     $num = imap_num_msg($imap);



     //if there is a message in your inbox

     if( $num >0 ) {

          //read that mail recently arrived

          echo imap_qprint(imap_body($imap, $num));

     }



     //close the stream

     imap_close($imap);

}

?>

add a note