cvs: phpdoc /en/reference/imap reference.xml /en/reference/imap/functions imap-bodystruct.xml imap-close.xml imap-fetch-overview.xml
imap-fetchheader.xml imap-list.xml imap-listscan.xml imap-lsub.xml imap-mail.xml imap-search.xml

didou Mon Jan 15 00:54:40 2007 UTC Modified files: /phpdoc/en/reference/imap reference.xml /phpdoc/en/reference/imap/functions imap-bodystruct.xml imap-close.xml imap-fetch-overview.xml imap-fetchheader.xml imap-list.xml imap-listscan.xml imap-lsub.xml imap-mail.xml imap-search.xml Log: imap function may not work perfectly on POP3 servers document imap_bodystruct() add cross-links

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/reference.xml?r1=1.17&r2=1.18&diff_format=u Index: phpdoc/en/reference/imap/reference.xml diff -u phpdoc/en/reference/imap/reference.xml:1.17 phpdoc/en/reference/imap/reference.xml:1.18 --- phpdoc/en/reference/imap/reference.xml:1.17 Sun Sep 4 19:39:16 2005 +++ phpdoc/en/reference/imap/reference.xml Mon Jan 15 00:54:40 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.17 $ --> +<!-- $Revision: 1.18 $ --> <!-- Purpose: remote.mail --> <!-- Membership: bundled, external --> @@ -9,12 +9,15 @@ <partintro> <section id="imap.intro"> - &reftitle.intro; - <para> - These functions are not limited to the <acronym>IMAP</acronym> protocol, - despite their name. The underlying c-client library also supports - <acronym>NNTP</acronym>, <acronym>POP3</acronym> and local mailbox access - methods. + &reftitle.intro; + <para> + These functions enable you to operate with the <acronym>IMAP</acronym> + protocol, as well as the <acronym>NNTP</acronym>, <acronym>POP3</acronym> + and local mailbox access methods. + </para> + <para> + Be warned however, that some of IMAP functions will not work correctly + with the POP protocol. </para> </section> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-bodystruct.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-bodystruct.xml diff -u phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.6 phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.6 Mon Jan 15 00:05:58 2007 +++ phpdoc/en/reference/imap/functions/imap-bodystruct.xml Mon Jan 15 00:54:40 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id='function.imap-bodystruct'> <refnamediv> <refname>imap_bodystruct</refname> @@ -14,7 +14,7 @@ <methodparam><type>string</type><parameter>section</parameter></methodparam> </methodsynopsis> <para> - &warn.undocumented.func; + Read the structure of a specified body section of a specific message. </para> </refsect1> <refsect1 role="parameters"> @@ -34,12 +34,101 @@ <term><parameter>section</parameter></term> <listitem> <para> + The body section to read </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the information in an object with following properties: + <itemizedlist> + <listitem> + <simpara> + type - + </simpara> + </listitem> + <listitem> + <simpara> + encoding - + </simpara> + </listitem> + <listitem> + <simpara> + ifsubtype - + </simpara> + </listitem> + <listitem> + <simpara> + subtype - + </simpara> + </listitem> + <listitem> + <simpara> + ifdescription - + </simpara> + </listitem> + <listitem> + <simpara> + description - + </simpara> + </listitem> + <listitem> + <simpara> + ifid - + </simpara> + </listitem> + <listitem> + <simpara> + id - + </simpara> + </listitem> + <listitem> + <simpara> + lines - number of lines + </simpara> + </listitem> + <listitem> + <simpara> + bytes - size of message, in bytes + </simpara> + </listitem> + <listitem> + <simpara> + ifdisposition - + </simpara> + </listitem> + <listitem> + <simpara> + disposition - + </simpara> + </listitem> + <listitem> + <simpara> + ifdparameters - + </simpara> + </listitem> + <listitem> + <simpara> + dparameters - + </simpara> + </listitem> + <listitem> + <simpara> + ifparameters - + </simpara> + </listitem> + <listitem> + <simpara> + parameters - + </simpara> + </listitem> + </itemizedlist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-close.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-close.xml diff -u phpdoc/en/reference/imap/functions/imap-close.xml:1.9 phpdoc/en/reference/imap/functions/imap-close.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-close.xml:1.9 Mon Jan 15 00:05:58 2007 +++ phpdoc/en/reference/imap/functions/imap-close.xml Mon Jan 15 00:54:40 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imap-close"> <refnamediv> <refname>imap_close</refname> @@ -27,7 +27,8 @@ <para> If set to <constant>CL_EXPUNGE</constant>, the function will silently expunge the mailbox before closing, removing all messages marked for - deletion. + deletion. You can achieve the same thing by using + <function>imap_expunge</function> </para> </listitem> </varlistentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetch-overview.xml?r1=1.12&r2=1.13&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-fetch-overview.xml diff -u phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.12 phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.13 --- phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.12 Mon Jan 15 00:05:58 2007 +++ phpdoc/en/reference/imap/functions/imap-fetch-overview.xml Mon Jan 15 00:54:40 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <refentry id="function.imap-fetch-overview"> <refnamediv> <refname>imap_fetch_overview</refname> @@ -163,6 +163,14 @@ </example> </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imap_fetchheader</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetchheader.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-fetchheader.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.8 phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.8 Mon Jan 15 00:05:58 2007 +++ phpdoc/en/reference/imap/functions/imap-fetchheader.xml Mon Jan 15 00:54:40 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imap-fetchheader"> <refnamediv> <refname>imap_fetchheader</refname> @@ -72,6 +72,14 @@ Returns the header of the specified message as a text string. </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imap_fetch_overview</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-list.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-list.xml diff -u phpdoc/en/reference/imap/functions/imap-list.xml:1.8 phpdoc/en/reference/imap/functions/imap-list.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-list.xml:1.8 Mon Jan 15 00:05:58 2007 +++ phpdoc/en/reference/imap/functions/imap-list.xml Mon Jan 15 00:54:40 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imap-list"> <refnamediv> <refname>imap_list</refname> @@ -91,6 +91,7 @@ <para> <simplelist> <member><function>imap_getmailboxes</function></member> + <member><function>imap_lsub</function></member> </simplelist> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-listscan.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-listscan.xml diff -u phpdoc/en/reference/imap/functions/imap-listscan.xml:1.4 phpdoc/en/reference/imap/functions/imap-listscan.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-listscan.xml:1.4 Mon Jan 15 00:05:58 2007 +++ phpdoc/en/reference/imap/functions/imap-listscan.xml Mon Jan 15 00:54:40 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-listscan"> <refnamediv> <refname>imap_listscan</refname> @@ -80,6 +80,7 @@ <para> <simplelist> <member><function>imap_listmailbox</function></member> + <member><function>imap_search</function></member> </simplelist> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-lsub.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-lsub.xml diff -u phpdoc/en/reference/imap/functions/imap-lsub.xml:1.4 phpdoc/en/reference/imap/functions/imap-lsub.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-lsub.xml:1.4 Mon Jan 15 00:05:58 2007 +++ phpdoc/en/reference/imap/functions/imap-lsub.xml Mon Jan 15 00:54:40 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-lsub"> <refnamediv> <refname>imap_lsub</refname> @@ -59,6 +59,15 @@ Returns an array of all the subscribed mailboxes. </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imap_list</function></member> + <member><function>imap_getmailboxes</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mail.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mail.xml diff -u phpdoc/en/reference/imap/functions/imap-mail.xml:1.8 phpdoc/en/reference/imap/functions/imap-mail.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-mail.xml:1.8 Mon Jan 15 00:05:58 2007 +++ phpdoc/en/reference/imap/functions/imap-mail.xml Mon Jan 15 00:54:40 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imap-mail"> <refnamediv> <refname>imap_mail</refname> @@ -97,6 +97,14 @@ &return.success; </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mail</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-search.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-search.xml diff -u phpdoc/en/reference/imap/functions/imap-search.xml:1.9 phpdoc/en/reference/imap/functions/imap-search.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-search.xml:1.9 Mon Jan 15 00:05:58 2007 +++ phpdoc/en/reference/imap/functions/imap-search.xml Mon Jan 15 00:54:40 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imap-search"> <refnamediv> <refname>imap_search</refname> @@ -219,6 +219,14 @@ </informaltable> </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imap_listscan</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file