<!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>Returns header for a message</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-fetchbody.html">imap_fetchbody</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-fetchmime.html">imap_fetchmime</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-fetchheader" class="refentry"> <div class="refnamediv"> <h1 class="refname">imap_fetchheader</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_fetchheader</span> — <span class="dc-title">Returns header for a message</span></p> </div> <div class="refsect1 description" id="refsect1-function.imap-fetchheader-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><strong>imap_fetchheader</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"> This function causes a fetch of the complete, unfiltered <a href="http://www.faqs.org/rfcs/rfc2822" class="link external">» RFC2822</a> format header of the specified message. </p> </div> <div class="refsect1 parameters" id="refsect1-function.imap-fetchheader-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter"> imap_stream</code></em></span><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> <dt> <span class="term"><em><code class="parameter">msg_number</code></em></span> <dd> <p class="para"> The message number </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">options</code></em></span> <dd> <p class="para"> The possible <em><code class="parameter">options</code></em> are: <ul class="itemizedlist"> <li class="listitem"> <span class="simpara"> <strong><code>FT_UID</code></strong> - The <em><code class="parameter">msgno</code></em> argument is a UID </span> </li> <li class="listitem"> <span class="simpara"> <strong><code>FT_INTERNAL</code></strong> - The return string is in "internal" format, without any attempt to canonicalize to CRLF newlines </span> </li> <li class="listitem"> <span class="simpara"> <strong><code>FT_PREFETCHTEXT</code></strong> - The RFC822.TEXT should be pre-fetched at the same time. This avoids an extra RTT on an <acronym title="Internet Message Access Protocol">IMAP</acronym> connection if a full message text is desired (e.g. in a "save to local file" operation) </span> </li> </ul> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.imap-fetchheader-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the header of the specified message as a text string. </p> </div> <div class="refsect1 seealso" id="refsect1-function.imap-fetchheader-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.imap-fetch-overview.html" class="function" rel="rdfs-seeAlso">imap_fetch_overview()</a> - Read an overview of the information in the headers of the given message</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-fetchbody.html">imap_fetchbody</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-fetchmime.html">imap_fetchmime</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>