mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
3a2da7cbd8
CS Replaced <programlisting> ... with <listitem> Added constant/parameter tags Added See Also parts Used &return.success; Added some para to make the whole thing more easy to read Removed redundancy git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@153120 c90b9560-bf6c-de11-be94-00142212c4b1
73 lines
2.3 KiB
XML
73 lines
2.3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.5 $ -->
|
|
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
|
|
<refentry id="function.imap-body">
|
|
<refnamediv>
|
|
<refname>imap_body</refname>
|
|
<refpurpose>Read the message body</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>imap_body</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></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>imap_body</function> returns the body of the message,
|
|
numbered <parameter>msg_number</parameter> in the current
|
|
mailbox.
|
|
</para>
|
|
<para>
|
|
The optional <parameter>options</parameter> are a bit mask
|
|
with one or more of the following:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>FT_UID</constant> - The <parameter>msg_number</parameter> is a UID
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>FT_PEEK</constant> - Do not set the \Seen flag if not already set
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>FT_INTERNAL</constant> - The return string is in internal format, will
|
|
not canonicalize to CRLF.
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<function>imap_body</function> will only return a verbatim copy of the
|
|
message body. To extract single parts of a multipart MIME-encoded
|
|
message you have to use <function>imap_fetchstructure</function> to
|
|
analyze its structure and <function>imap_fetchbody</function> to
|
|
extract a copy of a single body component.
|
|
</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
|
|
-->
|