svn: /phpdoc/en/trunk/reference/imap/ functions/imap-fetchmime.xml versions.xml
| From: | Stanislav Malyshev | Date: | Thu, 17 Mar 2011 19:27:51 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/imap/ functions/imap-fetchmime.xml versions.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7866@lists.php.net to get a copy of this message | ||
stas Thu, 17 Mar 2011 19:27:51 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=309356
Log:
document imap_fetchmime
Changed paths:
A phpdoc/en/trunk/reference/imap/functions/imap-fetchmime.xml
U phpdoc/en/trunk/reference/imap/versions.xml
Added: phpdoc/en/trunk/reference/imap/functions/imap-fetchmime.xml
===================================================================
--- phpdoc/en/trunk/reference/imap/functions/imap-fetchmime.xml (rev 0)
+++ phpdoc/en/trunk/reference/imap/functions/imap-fetchmime.xml 2011-03-17 19:27:51 UTC (rev 309356)
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 297028 $ -->
+<refentry xml:id="function.imap-fetchmime" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+ <refname>imap_fetchmime</refname>
+ <refpurpose>Fetch MIME headers for a particular section of the message</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>imap_fetchmime</methodname>
+
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
+
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
+
<methodparam><type>string</type><parameter>section</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
+ </methodsynopsis>
+ <para>
+ Fetch the MIME headers of a particular section of the body of the specified messages.
+ </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>section</parameter></term>
+ <listitem>
+ <para>
+ The part number. It is a string of integers delimited by period which
+ index into a body part list as per the IMAP4 specification
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the MIME headers of a particular section of the body of the specified messages as a
+ text string.
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>imap_fetchbody</function></member>
+ <member><function>imap_fetchstructure</function></member>
+ <member><function>imap_fetchheader</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
+-->
Modified: phpdoc/en/trunk/reference/imap/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/imap/versions.xml 2011-03-17 19:12:39 UTC (rev 309355)
+++ phpdoc/en/trunk/reference/imap/versions.xml 2011-03-17 19:27:51 UTC (rev 309356)
@@ -22,6 +22,7 @@
<function name='imap_expunge' from='PHP 4, PHP 5'/>
<function name='imap_fetch_overview' from='PHP 4, PHP 5'/>
<function name='imap_fetchbody' from='PHP 4, PHP 5'/>
+ <function name='imap_fetchmime' from='PHP 5 >= 5.3.6'/>
<function name='imap_fetchheader' from='PHP 4, PHP 5'/>
<function name='imap_fetchstructure' from='PHP 4, PHP 5'/>
<function name='imap_fetchtext' from='PHP 4, PHP 5'/>
@@ -99,4 +100,4 @@
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
--->
\ No newline at end of file
+-->