2002-04-15 00:12:54 +00:00
|
|
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
2002-10-09 14:55:05 +00:00
|
|
|
<!-- $Revision: 1.3 $ -->
|
2002-04-15 00:12:54 +00:00
|
|
|
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
|
|
|
|
|
<refentry id="function.imap-fetchheader">
|
|
|
|
|
<refnamediv>
|
|
|
|
|
<refname>imap_fetchheader</refname>
|
|
|
|
|
<refpurpose>Returns header for a message</refpurpose>
|
|
|
|
|
</refnamediv>
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Description</title>
|
|
|
|
|
<methodsynopsis>
|
|
|
|
|
<type>string</type><methodname>imap_fetchheader</methodname>
|
2002-10-09 14:55:05 +00:00
|
|
|
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
|
2002-04-15 00:12:54 +00:00
|
|
|
<methodparam><type>int</type><parameter>msgno</parameter></methodparam>
|
2002-10-09 14:55:05 +00:00
|
|
|
<methodparam><type>int</type><parameter>options</parameter></methodparam>
|
2002-04-15 00:12:54 +00:00
|
|
|
</methodsynopsis>
|
|
|
|
|
<para>
|
|
|
|
|
This function causes a fetch of the complete, unfiltered
|
|
|
|
|
<ulink url="&url.rfc;rfc2822.html">RFC2822</ulink>
|
|
|
|
|
format header of the specified message as a text string and
|
|
|
|
|
returns that text string.
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
The options are:
|
|
|
|
|
<informalexample>
|
|
|
|
|
<literallayout>
|
|
|
|
|
FT_UID The msgno argument is a UID
|
|
|
|
|
FT_INTERNAL The return string is in "internal" format,
|
|
|
|
|
without any attempt to canonicalize to CRLF
|
|
|
|
|
newlines
|
|
|
|
|
FT_PREFETCHTEXT The RFC822.TEXT should be pre-fetched at the
|
|
|
|
|
same time. This avoids an extra RTT on an
|
|
|
|
|
IMAP connection if a full message text is
|
|
|
|
|
desired (e.g. in a "save to local file"
|
|
|
|
|
operation)
|
|
|
|
|
</literallayout>
|
|
|
|
|
</informalexample>
|
|
|
|
|
</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:"../../../../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
|
|
|
|
|
-->
|
