cvs: phpdoc /en/reference/imap/functions imap-append.xml imap-body.xml imap-bodystruct.xml imap-check.xml imap-clearflag-full.xml imap-close.xml
imap-createmailbox.xml imap-delete.xml imap-deletemailbox.xml imap-expunge.xml imap-fetch-overview.xml imap-fetchbody.xml imap-fetchheader.xml
imap-fetchstructure.xml imap-get-quota.xml imap-get-quotaroot.xml imap-getmailboxes.xml imap-getsubscribed.xml imap-header.xml imap-headerinfo.xml
imap-headers.xml imap-list.xml imap-listmailbox.xml imap-listscan.xml imap-listsubscribed.xml imap-lsub.xml imap-mail-copy.xml imap-mail-move.xml
imap-mailboxmsginfo.xml imap-msgno.xml imap-num-msg.xml imap-num-recent.xml imap-open.xml imap-ping.xml imap-renamemailbox.xml imap-reopen.xml
imap-scanmailbox.xml imap-search.xml imap-set-quota.xml imap-setacl.xml imap-setflag-full.xml imap-sort.xml imap-status.xml imap-subscribe.xml
imap-thread.xml imap-uid.xml imap-undelete.xml imap-unsubscribe.xml

mfischer Wed Oct 9 10:55:05 2002 EDT Added files: /phpdoc/en/reference/imap/functions imap-list.xml imap-listscan.xml imap-lsub.xml Modified files: /phpdoc/en/reference/imap/functions imap-append.xml imap-body.xml imap-bodystruct.xml imap-check.xml imap-clearflag-full.xml imap-close.xml imap-createmailbox.xml imap-delete.xml imap-deletemailbox.xml imap-expunge.xml imap-fetch-overview.xml imap-fetchbody.xml imap-fetchheader.xml imap-fetchstructure.xml imap-get-quota.xml imap-get-quotaroot.xml imap-getmailboxes.xml imap-getsubscribed.xml imap-header.xml imap-headerinfo.xml imap-headers.xml imap-listmailbox.xml imap-listsubscribed.xml imap-mail-copy.xml imap-mail-move.xml imap-mailboxmsginfo.xml imap-msgno.xml imap-num-msg.xml imap-num-recent.xml imap-open.xml imap-ping.xml imap-renamemailbox.xml imap-reopen.xml imap-scanmailbox.xml imap-search.xml imap-set-quota.xml imap-setacl.xml imap-setflag-full.xml imap-sort.xml imap-status.xml imap-subscribe.xml imap-thread.xml imap-uid.xml imap-undelete.xml imap-unsubscribe.xml Log: - Sync most protos with current source. - Move alised documented to their real function name and document what an alias is.

Index: phpdoc/en/reference/imap/functions/imap-append.xml diff -u phpdoc/en/reference/imap/functions/imap-append.xml:1.2 phpdoc/en/reference/imap/functions/imap-append.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-append.xml:1.2 Wed Apr 17 02:39:16 2002 +++ phpdoc/en/reference/imap/functions/imap-append.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-append"> <refnamediv> @@ -11,11 +11,11 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_append</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_append</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>mbox</parameter></methodparam> <methodparam><type>string</type><parameter>message</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> Returns &true; on sucess, &false; on error. @@ -23,8 +23,8 @@ <para> <function>imap_append</function> appends a string message to the specified mailbox <parameter>mbox</parameter>. If the optional - <parameter>flags</parameter> is specified, writes the - <parameter>flags</parameter> to that mailbox also. + <parameter>options</parameter> is specified, writes the + <parameter>options</parameter> to that mailbox also. </para> <para> When talking to the Cyrus IMAP server, you must use "\r\n" as Index: phpdoc/en/reference/imap/functions/imap-body.xml diff -u phpdoc/en/reference/imap/functions/imap-body.xml:1.2 phpdoc/en/reference/imap/functions/imap-body.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-body.xml:1.2 Wed Apr 17 02:39:16 2002 +++ phpdoc/en/reference/imap/functions/imap-body.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-body"> <refnamediv> @@ -10,9 +10,9 @@ <title>Description</title> <methodsynopsis> <type>string</type><methodname>imap_body</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <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>flags</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> <function>imap_body</function> returns the body of the message, Index: phpdoc/en/reference/imap/functions/imap-bodystruct.xml diff -u phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.2 phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.2 Wed Apr 17 02:39:16 2002 +++ phpdoc/en/reference/imap/functions/imap-bodystruct.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 --> <refentry id='function.imap-bodystruct'> <refnamediv> @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>object</type><methodname>imap_bodystruct</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> <methodparam><type>int</type><parameter>msg_no</parameter></methodparam> <methodparam><type>int</type><parameter>section</parameter></methodparam> </methodsynopsis> Index: phpdoc/en/reference/imap/functions/imap-check.xml diff -u phpdoc/en/reference/imap/functions/imap-check.xml:1.2 phpdoc/en/reference/imap/functions/imap-check.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-check.xml:1.2 Wed Apr 17 02:39:16 2002 +++ phpdoc/en/reference/imap/functions/imap-check.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-check"> <refnamediv> @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>object</type><methodname>imap_check</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> Returns information about the current mailbox. Returns &false; on Index: phpdoc/en/reference/imap/functions/imap-clearflag-full.xml diff -u phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.3 phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.3 Mon Jun 10 04:04:03 2002 +++ phpdoc/en/reference/imap/functions/imap-clearflag-full.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-clearflag-full"> <refnamediv> @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>string</type><methodname>imap_clearflag_full</methodname> - <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <type>bool</type><methodname>imap_clearflag_full</methodname> + <methodparam><type>resource</type><parameter>stream</parameter></methodparam> <methodparam><type>string</type><parameter>sequence</parameter></methodparam> <methodparam><type>string</type><parameter>flag</parameter></methodparam> <methodparam><type>string</type><parameter>options</parameter></methodparam> Index: phpdoc/en/reference/imap/functions/imap-close.xml diff -u phpdoc/en/reference/imap/functions/imap-close.xml:1.2 phpdoc/en/reference/imap/functions/imap-close.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-close.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-close.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-close"> <refnamediv> @@ -9,9 +9,9 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_close</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + <type>bool</type><methodname>imap_close</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> Close the imap stream. Takes an optional Index: phpdoc/en/reference/imap/functions/imap-createmailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.2 phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-createmailbox.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-createmailbox"> <refnamediv> @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_createmailbox</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_createmailbox</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>mbox</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/imap/functions/imap-delete.xml diff -u phpdoc/en/reference/imap/functions/imap-delete.xml:1.2 phpdoc/en/reference/imap/functions/imap-delete.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-delete.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-delete.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-delete"> <refnamediv> @@ -11,10 +11,10 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_delete</methodname> + <type>bool</type><methodname>imap_delete</methodname> <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> Returns &true;. Index: phpdoc/en/reference/imap/functions/imap-deletemailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.2 phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-deletemailbox.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-deletemailbox"> <refnamediv> @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_deletemailbox</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_deletemailbox</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>mbox</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/imap/functions/imap-expunge.xml diff -u phpdoc/en/reference/imap/functions/imap-expunge.xml:1.2 phpdoc/en/reference/imap/functions/imap-expunge.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-expunge.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-expunge.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-expunge"> <refnamediv> @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_expunge</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_expunge</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> <function>imap_expunge</function> deletes all the messages marked Index: phpdoc/en/reference/imap/functions/imap-fetch-overview.xml diff -u phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.2 phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-fetch-overview.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-fetch-overview"> <refnamediv> @@ -12,9 +12,9 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_fetch_overview</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>sequence</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> This function fetches mail headers for the given Index: phpdoc/en/reference/imap/functions/imap-fetchbody.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.2 phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-fetchbody.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-fetchbody"> <refnamediv> @@ -12,10 +12,10 @@ <title>Description</title> <methodsynopsis> <type>string</type><methodname>imap_fetchbody</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <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>flags</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>flags</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> This function causes a fetch of a particular section of the body Index: phpdoc/en/reference/imap/functions/imap-fetchheader.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.2 phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-fetchheader.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-fetchheader"> <refnamediv> @@ -10,9 +10,9 @@ <title>Description</title> <methodsynopsis> <type>string</type><methodname>imap_fetchheader</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>int</type><parameter>msgno</parameter></methodparam> - <methodparam><type>int</type><parameter>flags</parameter></methodparam> + <methodparam><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> This function causes a fetch of the complete, unfiltered Index: phpdoc/en/reference/imap/functions/imap-fetchstructure.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchstructure.xml:1.2 phpdoc/en/reference/imap/functions/imap-fetchstructure.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-fetchstructure.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-fetchstructure.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-fetchstructure"> <refnamediv> @@ -12,9 +12,9 @@ <title>Description</title> <methodsynopsis> <type>object</type><methodname>imap_fetchstructure</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <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>flags</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> This function fetches all the structured information for a given Index: phpdoc/en/reference/imap/functions/imap-get-quota.xml diff -u phpdoc/en/reference/imap/functions/imap-get-quota.xml:1.6 phpdoc/en/reference/imap/functions/imap-get-quota.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-get-quota.xml:1.6 Tue Aug 6 03:39:46 2002 +++ phpdoc/en/reference/imap/functions/imap-get-quota.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-get-quota"> <refnamediv> @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_get_quota</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml diff -u phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml:1.1 phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml:1.2 --- phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml:1.1 Mon Aug 5 18:04:21 2002 +++ phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.imap-get-quotaroot"> <refnamediv> <refname>imap_get_quotaroot</refname> @@ -11,7 +11,7 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_get_quotaroot</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/imap/functions/imap-getmailboxes.xml diff -u phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.2 phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.2 Wed Apr 17 02:39:18 2002 +++ phpdoc/en/reference/imap/functions/imap-getmailboxes.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-getmailboxes"> <refnamediv> @@ -13,7 +13,7 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_getmailboxes</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>ref</parameter></methodparam> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> Index: phpdoc/en/reference/imap/functions/imap-getsubscribed.xml diff -u phpdoc/en/reference/imap/functions/imap-getsubscribed.xml:1.2 phpdoc/en/reference/imap/functions/imap-getsubscribed.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-getsubscribed.xml:1.2 Wed Apr 17 02:39:18 2002 +++ phpdoc/en/reference/imap/functions/imap-getsubscribed.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-getsubscribed"> <refnamediv> @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_getsubscribed</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>ref</parameter></methodparam> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> Index: phpdoc/en/reference/imap/functions/imap-header.xml diff -u phpdoc/en/reference/imap/functions/imap-header.xml:1.2 phpdoc/en/reference/imap/functions/imap-header.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-header.xml:1.2 Wed Apr 17 02:39:18 2002 +++ phpdoc/en/reference/imap/functions/imap-header.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-header"> <refnamediv> @@ -10,15 +10,15 @@ <title>Description</title> <methodsynopsis> <type>object</type><methodname>imap_header</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <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>fromlength</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>subjectlength</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam> </methodsynopsis> <para> - This is an alias to <function>imap_headerinfo</function> - and is identical to this in any way. + This function is an alias to <function>imap_headerinfo</function> + and is identical to it in every way. </para> </refsect1> </refentry> Index: phpdoc/en/reference/imap/functions/imap-headerinfo.xml diff -u phpdoc/en/reference/imap/functions/imap-headerinfo.xml:1.2 phpdoc/en/reference/imap/functions/imap-headerinfo.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-headerinfo.xml:1.2 Wed Apr 17 02:39:18 2002 +++ phpdoc/en/reference/imap/functions/imap-headerinfo.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-headerinfo"> <refnamediv> @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>object</type><methodname>imap_headerinfo</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <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>fromlength</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>subjectlength</parameter></methodparam> Index: phpdoc/en/reference/imap/functions/imap-headers.xml diff -u phpdoc/en/reference/imap/functions/imap-headers.xml:1.2 phpdoc/en/reference/imap/functions/imap-headers.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-headers.xml:1.2 Wed Apr 17 02:39:18 2002 +++ phpdoc/en/reference/imap/functions/imap-headers.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-headers"> <refnamediv> @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_headers</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> Returns an array of string formatted with header info. One Index: phpdoc/en/reference/imap/functions/imap-listmailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-listmailbox.xml:1.2 phpdoc/en/reference/imap/functions/imap-listmailbox.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-listmailbox.xml:1.2 Wed Apr 17 02:39:19 2002 +++ phpdoc/en/reference/imap/functions/imap-listmailbox.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-listmailbox"> <refnamediv> @@ -10,35 +10,13 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_listmailbox</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>ref</parameter></methodparam> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> <para> - Returns an array containing the names of the mailboxes. - See <function>imap_getmailboxes</function> for a description - of <parameter>ref</parameter> and <parameter>pattern</parameter>. - </para> - <para> - <example> - <title><function>imap_listmailbox</function> example</title> - <programlisting role="php"> -<![CDATA[ -$mbox = imap_open("{your.imap.host}","username","password",OP_HALFOPEN) - or die("can't connect: ".imap_last_error()); - -$list = imap_listmailbox($mbox,"{your.imap.host}","*"); -if(is_array($list)) { - reset($list); - while (list($key, $val) = each($list)) - print imap_utf7_decode($val)."<br>\n"; -} else - print "imap_listmailbox failed: ".imap_last_error()."\n"; - -imap_close($mbox); -]]> - </programlisting> - </example> + This function is an alias to <function>imap_list</function> + and is identical to it in every way. </para> </refsect1> </refentry> Index: phpdoc/en/reference/imap/functions/imap-listsubscribed.xml diff -u phpdoc/en/reference/imap/functions/imap-listsubscribed.xml:1.2 phpdoc/en/reference/imap/functions/imap-listsubscribed.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-listsubscribed.xml:1.2 Wed Apr 17 02:39:19 2002 +++ phpdoc/en/reference/imap/functions/imap-listsubscribed.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-listsubscribed"> <refnamediv> @@ -10,15 +10,13 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_listsubscribed</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>ref</parameter></methodparam> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> <para> - Returns an array of all the mailboxes that you have - subscribed. This is almost identical to - <function>imap_listmailbox</function>, but will only return - mailboxes the user you logged in as has subscribed. + This function is an alias to <function>imap_lsub</function> + and is identical to it in every way. </para> </refsect1> </refentry> Index: phpdoc/en/reference/imap/functions/imap-mail-copy.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.2 phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.2 Wed Apr 17 02:39:19 2002 +++ phpdoc/en/reference/imap/functions/imap-mail-copy.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-mail-copy"> <refnamediv> @@ -9,11 +9,11 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_mail_copy</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_mail_copy</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>msglist</parameter></methodparam> <methodparam><type>string</type><parameter>mbox</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> Returns &true; on success and &false; on error. Index: phpdoc/en/reference/imap/functions/imap-mail-move.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.2 phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.2 Wed Apr 17 02:39:19 2002 +++ phpdoc/en/reference/imap/functions/imap-mail-move.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-mail-move"> <refnamediv> @@ -9,12 +9,15 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_mail_move</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_mail_move</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>msglist</parameter></methodparam> <methodparam><type>string</type><parameter>mbox</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> + <para> + Returns &true; on success and &false; on error. + </para> <para> Moves mail messages specified by <parameter>msglist</parameter> to specified mailbox. <parameter>msglist</parameter> is a range @@ -30,9 +33,6 @@ </simpara> </listitem> </itemizedlist> - </para> - <para> - Returns &true; on success and &false; on error. </para> </refsect1> </refentry> Index: phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml diff -u phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml:1.2 phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml:1.2 Wed Apr 17 02:39:19 2002 +++ phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-mailboxmsginfo"> <refnamediv> @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>object</type><methodname>imap_mailboxmsginfo</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> Returns information about the current mailbox. Returns &false; on Index: phpdoc/en/reference/imap/functions/imap-msgno.xml diff -u phpdoc/en/reference/imap/functions/imap-msgno.xml:1.2 phpdoc/en/reference/imap/functions/imap-msgno.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-msgno.xml:1.2 Wed Apr 17 02:39:20 2002 +++ phpdoc/en/reference/imap/functions/imap-msgno.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-msgno"> <refnamediv> @@ -13,7 +13,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>imap_msgno</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>int</type><parameter>uid</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/imap/functions/imap-num-msg.xml diff -u phpdoc/en/reference/imap/functions/imap-num-msg.xml:1.2 phpdoc/en/reference/imap/functions/imap-num-msg.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-num-msg.xml:1.2 Wed Apr 17 02:39:20 2002 +++ phpdoc/en/reference/imap/functions/imap-num-msg.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-num-msg"> <refnamediv> @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>imap_num_msg</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> Return the number of messages in the current mailbox. Index: phpdoc/en/reference/imap/functions/imap-num-recent.xml diff -u phpdoc/en/reference/imap/functions/imap-num-recent.xml:1.2 phpdoc/en/reference/imap/functions/imap-num-recent.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-num-recent.xml:1.2 Wed Apr 17 02:39:20 2002 +++ phpdoc/en/reference/imap/functions/imap-num-recent.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-num-recent"> <refnamediv> @@ -11,7 +11,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>imap_num_recent</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> Returns the number of recent messages in the current mailbox. Index: phpdoc/en/reference/imap/functions/imap-open.xml diff -u phpdoc/en/reference/imap/functions/imap-open.xml:1.2 phpdoc/en/reference/imap/functions/imap-open.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-open.xml:1.2 Wed Apr 17 02:39:20 2002 +++ phpdoc/en/reference/imap/functions/imap-open.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-open"> <refnamediv> @@ -9,11 +9,11 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_open</methodname> + <type>resource</type><methodname>imap_open</methodname> <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> <methodparam><type>string</type><parameter>username</parameter></methodparam> <methodparam><type>string</type><parameter>password</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> Returns an IMAP stream on success and &false; on error. This Index: phpdoc/en/reference/imap/functions/imap-ping.xml diff -u phpdoc/en/reference/imap/functions/imap-ping.xml:1.2 phpdoc/en/reference/imap/functions/imap-ping.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-ping.xml:1.2 Wed Apr 17 02:39:21 2002 +++ phpdoc/en/reference/imap/functions/imap-ping.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-ping"> <refnamediv> @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_ping</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_ping</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> Returns &true; if the stream is still alive, &false; otherwise. Index: phpdoc/en/reference/imap/functions/imap-renamemailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-renamemailbox.xml:1.2 phpdoc/en/reference/imap/functions/imap-renamemailbox.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-renamemailbox.xml:1.2 Wed Apr 17 02:39:21 2002 +++ phpdoc/en/reference/imap/functions/imap-renamemailbox.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-renamemailbox"> <refnamediv> @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_renamemailbox</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_renamemailbox</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>old_mbox</parameter></methodparam> <methodparam><type>string</type><parameter>new_mbox</parameter></methodparam> </methodsynopsis> Index: phpdoc/en/reference/imap/functions/imap-reopen.xml diff -u phpdoc/en/reference/imap/functions/imap-reopen.xml:1.2 phpdoc/en/reference/imap/functions/imap-reopen.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-reopen.xml:1.2 Wed Apr 17 02:39:21 2002 +++ phpdoc/en/reference/imap/functions/imap-reopen.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-reopen"> <refnamediv> @@ -9,10 +9,10 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_reopen</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_reopen</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> This function reopens the specified stream to a new mailbox on Index: phpdoc/en/reference/imap/functions/imap-scanmailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-scanmailbox.xml:1.2 phpdoc/en/reference/imap/functions/imap-scanmailbox.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-scanmailbox.xml:1.2 Wed Apr 17 02:39:21 2002 +++ phpdoc/en/reference/imap/functions/imap-scanmailbox.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-scanmailbox"> <refnamediv> @@ -13,19 +13,14 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_scanmailbox</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>ref</parameter></methodparam> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> <methodparam><type>string</type><parameter>content</parameter></methodparam> </methodsynopsis> <para> - Returns an array containing the names of the mailboxes that have - <parameter>content</parameter> in the text of the mailbox. - This function is similar to <function>imap_listmailbox</function>, - but it will additionally check for the presence of the string - <parameter>content</parameter> inside the mailbox data. - See <function>imap_getmailboxes</function> for a description - of <parameter>ref</parameter> and <parameter>pattern</parameter>. + This function is an alias to <function>imap_listscan</function> + and is identical to it in every way. </para> </refsect1> </refentry> Index: phpdoc/en/reference/imap/functions/imap-search.xml diff -u phpdoc/en/reference/imap/functions/imap-search.xml:1.2 phpdoc/en/reference/imap/functions/imap-search.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-search.xml:1.2 Wed Apr 17 02:39:21 2002 +++ phpdoc/en/reference/imap/functions/imap-search.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-search"> <refnamediv> @@ -13,9 +13,9 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_search</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>criteria</parameter></methodparam> - <methodparam><type>int</type><parameter>flags</parameter></methodparam> + <methodparam><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> This function performs a search on the mailbox currently opened Index: phpdoc/en/reference/imap/functions/imap-set-quota.xml diff -u phpdoc/en/reference/imap/functions/imap-set-quota.xml:1.3 phpdoc/en/reference/imap/functions/imap-set-quota.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-set-quota.xml:1.3 Mon Jul 29 14:10:13 2002 +++ phpdoc/en/reference/imap/functions/imap-set-quota.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-set-quota"> <refnamediv> @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_set_quota</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_set_quota</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> <methodparam><type>int</type><parameter>quota_limit</parameter></methodparam> </methodsynopsis> Index: phpdoc/en/reference/imap/functions/imap-setacl.xml diff -u phpdoc/en/reference/imap/functions/imap-setacl.xml:1.2 phpdoc/en/reference/imap/functions/imap-setacl.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-setacl.xml:1.2 Wed Apr 17 02:39:22 2002 +++ phpdoc/en/reference/imap/functions/imap-setacl.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 --> <refentry id='function.imap-setacl'> <refnamediv> @@ -11,8 +11,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_setacl</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <type>bool</type><methodname>imap_setacl</methodname> + <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> <methodparam><type>string</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>rights</parameter></methodparam> Index: phpdoc/en/reference/imap/functions/imap-setflag-full.xml diff -u phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.3 phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.3 Mon Jun 10 04:04:06 2002 +++ phpdoc/en/reference/imap/functions/imap-setflag-full.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-setflag-full"> <refnamediv> @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>string</type><methodname>imap_setflag_full</methodname> - <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <type>bool</type><methodname>imap_setflag_full</methodname> + <methodparam><type>resource</type><parameter>stream</parameter></methodparam> <methodparam><type>string</type><parameter>sequence</parameter></methodparam> <methodparam><type>string</type><parameter>flag</parameter></methodparam> <methodparam><type>string</type><parameter>options</parameter></methodparam> Index: phpdoc/en/reference/imap/functions/imap-sort.xml diff -u phpdoc/en/reference/imap/functions/imap-sort.xml:1.2 phpdoc/en/reference/imap/functions/imap-sort.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-sort.xml:1.2 Wed Apr 17 02:39:22 2002 +++ phpdoc/en/reference/imap/functions/imap-sort.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-sort"> <refnamediv> @@ -10,10 +10,11 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_sort</methodname> - <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>stream</parameter></methodparam> <methodparam><type>int</type><parameter>criteria</parameter></methodparam> <methodparam><type>int</type><parameter>reverse</parameter></methodparam> - <methodparam><type>int</type><parameter>options</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>search_criteria</parameter></methodparam> </methodsynopsis> <para> Returns an array of message numbers sorted by the given Index: phpdoc/en/reference/imap/functions/imap-status.xml diff -u phpdoc/en/reference/imap/functions/imap-status.xml:1.2 phpdoc/en/reference/imap/functions/imap-status.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-status.xml:1.2 Wed Apr 17 02:39:22 2002 +++ phpdoc/en/reference/imap/functions/imap-status.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-status"> <refnamediv> @@ -13,7 +13,7 @@ <title>Description</title> <methodsynopsis> <type>object</type><methodname>imap_status</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> <methodparam><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> Index: phpdoc/en/reference/imap/functions/imap-subscribe.xml diff -u phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.2 phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.2 Wed Apr 17 02:39:22 2002 +++ phpdoc/en/reference/imap/functions/imap-subscribe.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.7 --> <refentry id="function.imap-subscribe"> <refnamediv> @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_subscribe</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_subscribe</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>mbox</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/imap/functions/imap-thread.xml diff -u phpdoc/en/reference/imap/functions/imap-thread.xml:1.2 phpdoc/en/reference/imap/functions/imap-thread.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-thread.xml:1.2 Wed Apr 17 02:39:22 2002 +++ phpdoc/en/reference/imap/functions/imap-thread.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 --> <refentry id='function.imap-thread'> <refnamediv> @@ -11,9 +11,9 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_thread</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + <type>array</type><methodname>imap_thread</methodname> + <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> &warn.undocumented.func; Index: phpdoc/en/reference/imap/functions/imap-uid.xml diff -u phpdoc/en/reference/imap/functions/imap-uid.xml:1.2 phpdoc/en/reference/imap/functions/imap-uid.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-uid.xml:1.2 Wed Apr 17 02:39:22 2002 +++ phpdoc/en/reference/imap/functions/imap-uid.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-uid"> <refnamediv> @@ -13,7 +13,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>imap_uid</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>int</type><parameter>msgno</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/imap/functions/imap-undelete.xml diff -u phpdoc/en/reference/imap/functions/imap-undelete.xml:1.2 phpdoc/en/reference/imap/functions/imap-undelete.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-undelete.xml:1.2 Wed Apr 17 02:39:23 2002 +++ phpdoc/en/reference/imap/functions/imap-undelete.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-undelete"> <refnamediv> @@ -11,8 +11,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_undelete</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_undelete</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/imap/functions/imap-unsubscribe.xml diff -u phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.2 phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.2 Wed Apr 17 02:39:23 2002 +++ phpdoc/en/reference/imap/functions/imap-unsubscribe.xml Wed Oct 9 10:55:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-unsubscribe"> <refnamediv> @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>imap_unsubscribe</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <type>bool</type><methodname>imap_unsubscribe</methodname> + <methodparam><type>string</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>mbox</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/imap/functions/imap-list.xml +++ phpdoc/en/reference/imap/functions/imap-list.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.imap-list"> <refnamediv> <refname>imap_list</refname> <refpurpose>Read the list of mailboxes</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_list</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>ref</parameter></methodparam> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> <para> Returns an array containing the names of the mailboxes. See <function>imap_getmailboxes</function> for a description of <parameter>ref</parameter> and <parameter>pattern</parameter>. </para> <para> <example> <title><function>imap_list</function> example</title> <programlisting role="php"> <![CDATA[ $mbox = imap_open("{your.imap.host}","username","password",OP_HALFOPEN) or die("can't connect: ".imap_last_error()); $list = imap_list($mbox,"{your.imap.host}","*"); if(is_array($list)) { reset($list); while (list($key, $val) = each($list)) print imap_utf7_decode($val)."<br>\n"; } else print "imap_list failed: ".imap_last_error()."\n"; imap_close($mbox); ]]> </programlisting> </example> </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 --> Index: phpdoc/en/reference/imap/functions/imap-listscan.xml +++ phpdoc/en/reference/imap/functions/imap-listscan.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.imap-listscan"> <refnamediv> <refname>imap_listscan</refname> <refpurpose> Read the list of mailboxes, takes a string to search for in the text of the mailbox </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_listscan</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>ref</parameter></methodparam> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> <methodparam><type>string</type><parameter>content</parameter></methodparam> </methodsynopsis> <para> Returns an array containing the names of the mailboxes that have <parameter>content</parameter> in the text of the mailbox. This function is similar to <function>imap_listmailbox</function>, but it will additionally check for the presence of the string <parameter>content</parameter> inside the mailbox data. See <function>imap_getmailboxes</function> for a description of <parameter>ref</parameter> and <parameter>pattern</parameter>. </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 --> Index: phpdoc/en/reference/imap/functions/imap-lsub.xml +++ phpdoc/en/reference/imap/functions/imap-lsub.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.imap-lsub"> <refnamediv> <refname>imap_lsub</refname> <refpurpose>List all the subscribed mailboxes</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>array</type><methodname>imap_lsub</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>ref</parameter></methodparam> <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> <para> Returns an array of all the mailboxes that you have subscribed. This is almost identical to <function>imap_listmailbox</function>, but will only return mailboxes the user you logged in as has subscribed. </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 -->