<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Read the message body</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-binary.html">imap_binary</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-bodystruct.html">imap_bodystruct</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imap-body" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_body</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_body</span> — <span class="dc-title">Read the message body</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-body-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>imap_body</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$msg_number</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>imap_body()</strong></span> returns the body of the message,
numbered <code class="parameter">msg_number</code> in the current
mailbox.
</p>
<p class="para">
<span class="function"><strong>imap_body()</strong></span> will only return a verbatim copy of the
message body. To extract single parts of a multipart MIME-encoded
message you have to use <span class="function"><a href="function.imap-fetchstructure.html" class="function">imap_fetchstructure()</a></span> to
analyze its structure and <span class="function"><a href="function.imap-fetchbody.html" class="function">imap_fetchbody()</a></span> to
extract a copy of a single body component.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-body-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">
imap_stream</code></dt>
<dd>
<p class="para">An IMAP stream returned by
<span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span>.</p></dd>
<dt>
<code class="parameter">msg_number</code></dt>
<dd>
<p class="para">
The message number
</p>
</dd>
<dt>
<code class="parameter">options</code></dt>
<dd>
<p class="para">
The optional <code class="parameter">options</code> are a bit mask
with one or more of the following:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>FT_UID</code></strong> - The <code class="parameter">msg_number</code> is a UID
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FT_PEEK</code></strong> - Do not set the \Seen flag if not already set
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FT_INTERNAL</code></strong> - The return string is in internal format, will
not canonicalize to CRLF.
</span>
</li>
</ul>
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-body-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the body of the specified message, as a string.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-binary.html">imap_binary</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-bodystruct.html">imap_bodystruct</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
