didou Sun Jan 28 00:33:19 2007 UTC
Added files:
/phpdoc/en/reference/imap/functions imap-savebody.xml
Modified files:
/phpdoc/en/reference/imap/functions imap-fetchbody.xml
Log:
Document imap_savebody()
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetchbody.xml?r1=1.7&r2=1.8&diff_format=u
Index: phpdoc/en/reference/imap/functions/imap-fetchbody.xml
diff -u phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.7
phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.8
--- phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.7 Mon Jan 15
00:05:58 2007
+++ phpdoc/en/reference/imap/functions/imap-fetchbody.xml Sun Jan 28
00:33:19 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
<refentry id="function.imap-fetchbody">
<refnamediv>
<refname>imap_fetchbody</refname>
@@ -82,6 +82,7 @@
&reftitle.seealso;
<para>
<simplelist>
+ <member><function>imap_savebody</function></member>
<member><function>imap_fetchstructure</function></member>
</simplelist>
</para>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-savebody.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/imap/functions/imap-savebody.xml
+++ phpdoc/en/reference/imap/functions/imap-savebody.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.imap-savebody">
<refnamediv>
<refname>imap_savebody</refname>
<refpurpose>Save a specific body section to a file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imap_savebody</methodname>
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>mixed</type><parameter>file</parameter></methodparam>
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>part_number</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
Saves a part or the whole body of the specified message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-stream.description;
<varlistentry>
<term><parameter>file</parameter></term>
<listitem>
<para>
The path to the saved file as a string, or a valid file descriptor
returned by <function>fopen</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>msg_number</parameter></term>
<listitem>
<para>
The message number
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>part_number</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>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_fetchbody</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:"../../../../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
-->
