<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-fetchheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imap_fetchheader</refname>
  <refpurpose>Returns header for a message</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>imap_fetchheader</methodname>
   <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
   <methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   This function causes a fetch of the complete, unfiltered <link
   xlink:href="&url.rfc;2822">RFC2822</link> format header of the specified
   message.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-stream.description;
    <varlistentry>
     <term><parameter>msg_number</parameter></term>
     <listitem>
      <para>
       The message number
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       The possible <parameter>options</parameter> are:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>FT_UID</constant> - The <parameter>msgno</parameter>
          argument is a UID
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>FT_INTERNAL</constant> - The return string
          is in "internal" format, without any attempt to
          canonicalize to CRLF newlines
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>FT_PREFETCHTEXT</constant> - The RFC822.TEXT
          should be pre-fetched at the same time.  This avoids an
          extra RTT on an <acronym>IMAP</acronym> connection if a full message text is
          desired (e.g. in a "save to local file" operation)
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the header of the specified message as a text string.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_fetch_overview</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->