mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 04:18:56 +00:00
9a1ee6bfe3
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166311 c90b9560-bf6c-de11-be94-00142212c4b1
76 lines
2.4 KiB
XML
76 lines
2.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.5 $ -->
|
|
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 -->
|
|
<refentry id="function.imap-fetchbody">
|
|
<refnamediv>
|
|
<refname>imap_fetchbody</refname>
|
|
<refpurpose>
|
|
Fetch a particular section of the body of the message
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>imap_fetchbody</methodname>
|
|
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>part_number</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function causes a fetch of a particular section of the body
|
|
of the specified messages as a text string and returns that text
|
|
string. The section specification is a string of integers
|
|
delimited by period which index into a body part list as per the
|
|
IMAP4 specification. Body parts are not decoded by this function.
|
|
</para>
|
|
<para>
|
|
The <parameter>options</parameter> for
|
|
<function>imap_fetchbody</function> is a bitmask 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>
|
|
See also: <function>imap_fetchstructure</function>.
|
|
</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
|
|
-->
|