cvs: phpdoc /en language-snippets.ent /en/reference/imap/functions imap-8bit.xml imap-alerts.xml imap-append.xml imap-base64.xml imap-binary.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-errors.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-getacl.xml imap-getmailboxes.xml imap-getsubscribed.xml imap-headerinfo.xml imap-headers.xml imap-last-error.xml
imap-list.xml imap-listscan.xml imap-lsub.xml imap-mail-compose.xml imap-mail-copy.xml imap-mail-move.xml imap-mail.xml imap-mailboxmsginfo.xml
imap-mime-header-decode.xml imap-msgno.xml imap-num-msg.xml imap-num-recent.xml imap-open.xml imap-ping.xml imap-qprint.xml imap-renamemailbox.xml
imap-reopen.xml imap-rfc822-parse-adrlist.xml imap-rfc822-parse-headers.xml imap-rfc822-write-address.xml imap-s! earch.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-timeout.xml imap-uid.xml imap-undelete.xml
imap-unsubscribe.xml imap-utf7-decode.xml imap-utf7-encode.xml imap-utf8.xml

didou Mon Jan 15 00:05:59 2007 UTC Modified files: /phpdoc/en language-snippets.ent /phpdoc/en/reference/imap/functions imap-8bit.xml imap-alerts.xml imap-append.xml imap-base64.xml imap-binary.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-errors.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-getacl.xml imap-getmailboxes.xml imap-getsubscribed.xml imap-headerinfo.xml imap-headers.xml imap-last-error.xml imap-list.xml imap-listscan.xml imap-lsub.xml imap-mail-compose.xml imap-mail-copy.xml imap-mail-move.xml imap-mail.xml imap-mailboxmsginfo.xml imap-mime-header-decode.xml imap-msgno.xml imap-num-msg.xml imap-num-recent.xml imap-open.xml imap-ping.xml imap-qprint.xml imap-renamemailbox.xml imap-reopen.xml imap-rfc822-parse-adrlist.xml imap-rfc822-parse-headers.xml imap-rfc822-write-address.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-timeout.xml imap-uid.xml imap-undelete.xml imap-unsubscribe.xml imap-utf7-decode.xml imap-utf7-encode.xml imap-utf8.xml Log: imap: switch to new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.181&r2=1.182&diff_format=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.181 phpdoc/en/language-snippets.ent:1.182 --- phpdoc/en/language-snippets.ent:1.181 Sun Jan 14 03:48:41 2007 +++ phpdoc/en/language-snippets.ent Mon Jan 15 00:05:58 2007 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.181 $ --> +<!-- $Revision: 1.182 $ --> <!-- Keep 'em sorted --> @@ -245,6 +245,12 @@ dbm_identifier</parameter></term><listitem><para>The DBM link identifier, returned by <function>dbmopen</function>.</para></listitem></varlistentry>'> +<!-- IMAP notes --> + +<!ENTITY imap.imap-stream.description '<varlistentry><term><parameter> +imap_stream</parameter></term><listitem><para>An IMAP stream returned by +<function>imap_open</function>.</para></listitem></varlistentry>'> + <!-- Date and time entities --> <!ENTITY date.timezone.errors.description '<para> Every call to a date/time function will generate a <constant>E_NOTICE</constant> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-8bit.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-8bit.xml diff -u phpdoc/en/reference/imap/functions/imap-8bit.xml:1.4 phpdoc/en/reference/imap/functions/imap-8bit.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-8bit.xml:1.4 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-8bit.xml Mon Jan 15 00:05:58 2007 @@ -1,26 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-8bit"> <refnamediv> <refname>imap_8bit</refname> <refpurpose>Convert an 8bit string to a quoted-printable string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_8bit</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> </methodsynopsis> <para> Convert an 8bit string to a quoted-printable string (according to - <ulink url="&url.rfc;2045">RFC2045</ulink>, section - 6.7). + <ulink url="&url.rfc;2045">RFC2045</ulink>, section 6.7). </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The 8bit string to convert + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns a quoted-printable string. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_qprint</function>. + <simplelist> + <member><function>imap_qprint</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-alerts.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-alerts.xml diff -u phpdoc/en/reference/imap/functions/imap-alerts.xml:1.6 phpdoc/en/reference/imap/functions/imap-alerts.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-alerts.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-alerts.xml Mon Jan 15 00:05:58 2007 @@ -1,26 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imap-alerts"> <refnamediv> <refname>imap_alerts</refname> - <refpurpose>This function returns all IMAP alert messages (if any) that have occurred during this page request or since the alert stack was reset</refpurpose> + <refpurpose>Returns all IMAP alert messages that have occurred</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_alerts</methodname> <void/> </methodsynopsis> <para> - This function returns an array of all of the IMAP alert messages - generated since the last <function>imap_alerts</function> call, - or the beginning of the page. Returns &false; if no alert messages are - available. When <function>imap_alerts</function> is called, the alert - stack is subsequently cleared. The IMAP specification requires that these - messages be passed to the user. + Returns all of the IMAP alert messages generated since the last + <function>imap_alerts</function> call, or the beginning of the page. </para> <para> - See also <function>imap_errors</function> + When <function>imap_alerts</function> is called, the alert stack is + subsequently cleared. The IMAP specification requires that these messages + be passed to the user. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of all of the IMAP alert messages generated or &false; if + no alert messages are available. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imap_errors</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-append.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-append.xml diff -u phpdoc/en/reference/imap/functions/imap-append.xml:1.11 phpdoc/en/reference/imap/functions/imap-append.xml:1.12 --- phpdoc/en/reference/imap/functions/imap-append.xml:1.11 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-append.xml Mon Jan 15 00:05:58 2007 @@ -1,33 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry id="function.imap-append"> <refnamediv> <refname>imap_append</refname> <refpurpose>Append a string message to a specified mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <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>mailbox</parameter></methodparam> <methodparam><type>string</type><parameter>message</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - <function>imap_append</function> appends a string message to the - specified mailbox <parameter>mbox</parameter>. If the optional - <parameter>options</parameter> is specified, writes the - <parameter>options</parameter> to that mailbox also. + Appends a string message to the specified <parameter>mailbox</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>message</parameter></term> + <listitem> + <para> + The message to be append, as a string + </para> + <para> + When talking to the Cyrus IMAP server, you must use "\r\n" as + your end-of-line terminator instead of "\n" or the operation will + fail + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + If provided, the <parameter>options</parameter> will also be written + to the <parameter>mailbox</parameter> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - When talking to the Cyrus IMAP server, you must use "\r\n" as - your end-of-line terminator instead of "\n" or the operation will - fail. + &return.success; </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_append</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-base64.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-base64.xml diff -u phpdoc/en/reference/imap/functions/imap-base64.xml:1.5 phpdoc/en/reference/imap/functions/imap-base64.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-base64.xml:1.5 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-base64.xml Mon Jan 15 00:05:58 2007 @@ -1,25 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imap-base64"> <refnamediv> <refname>imap_base64</refname> <refpurpose>Decode BASE64 encoded text</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_base64</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - <function>imap_base64</function> function decodes BASE-64 encoded - <parameter>text</parameter> (see <ulink url="&url.rfc;2045">RFC2045</ulink>, - Section 6.8). The decoded message is returned as a string. + Decodes the given BASE-64 encoded <parameter>text</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The decoded text + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the decoded message as a string. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_binary</function>, - <function>base64_encode</function> and - <function>base64_decode</function>. + <simplelist> + <member><function>imap_binary</function></member> + <member><function>base64_encode</function></member> + <member><function>base64_decode</function></member> + <member><ulink url="&url.rfc;2045">RFC2045</ulink>, Section 6.8</member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-binary.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-binary.xml diff -u phpdoc/en/reference/imap/functions/imap-binary.xml:1.4 phpdoc/en/reference/imap/functions/imap-binary.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-binary.xml:1.4 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-binary.xml Mon Jan 15 00:05:58 2007 @@ -1,25 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-binary"> <refnamediv> <refname>imap_binary</refname> <refpurpose>Convert an 8bit string to a base64 string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_binary</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> </methodsynopsis> <para> - Convert an 8bit string to a base64 string (according to <ulink - url="&url.rfc;2045">RFC2045</ulink>, Section 6.8). + Convert an 8bit string to a base64 string according to <ulink + url="&url.rfc;2045">RFC2045</ulink>, Section 6.8. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns a base64 string. + <variablelist> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The 8bit string + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a base64 encoded string. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_base64</function>. + <simplelist> + <member><function>imap_base64</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-body.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-body.xml diff -u phpdoc/en/reference/imap/functions/imap-body.xml:1.6 phpdoc/en/reference/imap/functions/imap-body.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-body.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-body.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imap-body"> <refnamediv> <refname>imap_body</refname> <refpurpose>Read the message body</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_body</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -19,28 +19,6 @@ mailbox. </para> <para> - The optional <parameter>options</parameter> are a bit mask - 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> <function>imap_body</function> will only return a verbatim copy of the message body. To extract single parts of a multipart MIME-encoded message you have to use <function>imap_fetchstructure</function> to @@ -48,6 +26,55 @@ extract a copy of a single body component. </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>options</parameter></term> + <listitem> + <para> + The optional <parameter>options</parameter> are a bit mask + 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 body of the specified message, as a string. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-bodystruct.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-bodystruct.xml diff -u phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.5 phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.5 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-bodystruct.xml Mon Jan 15 00:05:58 2007 @@ -1,22 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id='function.imap-bodystruct'> <refnamediv> <refname>imap_bodystruct</refname> <refpurpose>Read the structure of a specified body section of a specific message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>imap_bodystruct</methodname> - <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>int</type><parameter>msg_no</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>section</parameter></methodparam> </methodsynopsis> <para> &warn.undocumented.func; </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> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-check.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-check.xml diff -u phpdoc/en/reference/imap/functions/imap-check.xml:1.6 phpdoc/en/reference/imap/functions/imap-check.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-check.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-check.xml Mon Jan 15 00:05:58 2007 @@ -1,26 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imap-check"> <refnamediv> <refname>imap_check</refname> <refpurpose>Check current mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>imap_check</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> - Returns information about the current mailbox. Returns &false; on - failure. + Checks information about the current mailbox. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The <function>imap_check</function> function checks the current - mailbox status on the server and returns the information in an - object with following properties: + <variablelist> + &imap.imap-stream.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> + Returns the information in an object with following properties: <itemizedlist> <listitem> <simpara> @@ -50,6 +56,12 @@ </listitem> </itemizedlist> </para> + <para> + Returns &false; on failure. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_check</function> example</title> @@ -63,9 +75,7 @@ ?> ]]> </programlisting> - <para> - this will output : - </para> + &example.outputs.similar; <screen> <![CDATA[ object(stdClass)(5) { http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-clearflag-full.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-clearflag-full.xml diff -u phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.8 phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.8 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-clearflag-full.xml Mon Jan 15 00:05:58 2007 @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imap-clearflag-full"> <refnamediv> <refname>imap_clearflag_full</refname> <refpurpose>Clears flags on messages</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_clearflag_full</methodname> - <methodparam><type>resource</type><parameter>stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>sequence</parameter></methodparam> <methodparam><type>string</type><parameter>flag</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> @@ -18,24 +18,65 @@ This function causes a store to delete the specified <parameter>flag</parameter> to the flags set for the messages in the specified <parameter>sequence</parameter>. - The flags which you can unset are "\\Seen", "\\Answered", - "\\Flagged", "\\Deleted", and "\\Draft" (as defined - by <ulink url="&url.rfc;2060">RFC2060</ulink>). &return.success;. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>options</parameter> are a bit mask and may contain - the single option: - <itemizedlist> - <listitem> - <simpara> - <constant>ST_UID</constant> - The sequence argument contains UIDs - instead of sequence numbers - </simpara> - </listitem> - </itemizedlist> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>sequence</parameter></term> + <listitem> + <para> + A sequence of message numbers. You can enumerate desired messages + with the <literal>X,Y</literal> syntax, or retrieve all messages + within an interval with the <literal>X:Y</literal> syntax + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flag</parameter></term> + <listitem> + <para> + The flags which you can unset are "\\Seen", "\\Answered", "\\Flagged", + "\\Deleted", and "\\Draft" (as defined by <ulink + url="&url.rfc;2060">RFC2060</ulink>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + <parameter>options</parameter> are a bit mask and may contain + the single option: + <itemizedlist> + <listitem> + <simpara> + <constant>ST_UID</constant> - The sequence argument contains UIDs + instead of sequence numbers + </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> - See also: <function>imap_setflag_full</function>. + <simplelist> + <member><function>imap_setflag_full</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-close.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-close.xml diff -u phpdoc/en/reference/imap/functions/imap-close.xml:1.8 phpdoc/en/reference/imap/functions/imap-close.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-close.xml:1.8 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-close.xml Mon Jan 15 00:05:58 2007 @@ -1,25 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imap-close"> <refnamediv> <refname>imap_close</refname> <refpurpose>Close an IMAP stream</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_close</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam> </methodsynopsis> <para> - Closes the imap stream. Takes an optional - <parameter>flag</parameter> <constant>CL_EXPUNGE</constant>, - which will silently expunge the mailbox before closing, - removing all messages marked for deletion. + Closes the imap stream. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>flag</parameter></term> + <listitem> + <para> + If set to <constant>CL_EXPUNGE</constant>, the function will silently + expunge the mailbox before closing, removing all messages marked for + deletion. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_open</function>. + <simplelist> + <member><function>imap_open</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-createmailbox.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-createmailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.11 phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.12 --- phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.11 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-createmailbox.xml Mon Jan 15 00:05:58 2007 @@ -1,25 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry id="function.imap-createmailbox"> <refnamediv> <refname>imap_createmailbox</refname> <refpurpose>Create a new mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_createmailbox</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> </methodsynopsis> <para> - <function>imap_createmailbox</function> creates a new mailbox - specified by <parameter>mbox</parameter>. Names containing - international characters should be encoded by <function>imap_utf7_encode</function> + Creates a new mailbox specified by <parameter>mbox</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information. Names containing international characters should be + encoded by <function>imap_utf7_encode</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - &return.success;. + &return.success; </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_createmailbox</function> example</title> @@ -76,11 +98,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_renamemailbox</function>, - <function>imap_deletemailbox</function> and - <function>imap_open</function> for the format - of <parameter>mbox</parameter> names. + <simplelist> + <member><function>imap_renamemailbox</function></member> + <member><function>imap_deletemailbox</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-delete.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-delete.xml diff -u phpdoc/en/reference/imap/functions/imap-delete.xml:1.10 phpdoc/en/reference/imap/functions/imap-delete.xml:1.11 --- phpdoc/en/reference/imap/functions/imap-delete.xml:1.10 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-delete.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imap-delete"> <refnamediv> <refname>imap_delete</refname> <refpurpose>Mark a message for deletion from current mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_delete</methodname> <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> @@ -14,28 +14,47 @@ <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - Returns &true;. + Marks messages listed in <parameter>msg_number</parameter> for deletion. + Messages marked for deletion will stay in the mailbox until either + <function>imap_expunge</function> is called or + <function>imap_close</function> is called with the optional parameter + <constant>CL_EXPUNGE</constant>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>imap_delete</function> marks messages listed - in <parameter>msg_number</parameter> for deletion. The optional - <parameter>flags</parameter> parameter only has a single option, - <parameter>FT_UID</parameter>, which tells the function to treat - the <parameter>msg_number</parameter> argument as a - <parameter>UID</parameter>. Messages marked for deletion will - stay in the mailbox until either - <function>imap_expunge</function> is called or - <function>imap_close</function> is called with the optional - parameter CL_EXPUNGE. + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>msg_number</parameter></term> + <listitem> + <para> + The message number + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + You can set the <constant>FT_UID</constant> which tells the function + to treat the <parameter>msg_number</parameter> argument as an + <literal>UID</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <note> - <para> - POP3 mailboxes do not have their message flags saved between - connections, so <function>imap_expunge</function> must be called during - the same connection in order for messages marked for deletion to - actually be purged. - </para> - </note> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true;. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_delete</function> example</title> @@ -65,10 +84,26 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + POP3 mailboxes do not have their message flags saved between + connections, so <function>imap_expunge</function> must be called during + the same connection in order for messages marked for deletion to + actually be purged. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_undelete</function>, - <function>imap_expunge</function>, and - <function>imap_close</function>. + <simplelist> + <member><function>imap_undelete</function></member> + <member><function>imap_expunge</function></member> + <member><function>imap_close</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-deletemailbox.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-deletemailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.5 phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.5 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-deletemailbox.xml Mon Jan 15 00:05:58 2007 @@ -1,30 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imap-deletemailbox"> <refnamediv> <refname>imap_deletemailbox</refname> <refpurpose>Delete a mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_deletemailbox</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> </methodsynopsis> <para> - <function>imap_deletemailbox</function> deletes the specified - mailbox (see <function>imap_open</function> for the format - of <parameter>mbox</parameter> names). + Deletes the specified <parameter>mailbox</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success;. + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_createmailbox</function>, - <function>imap_renamemailbox</function>, and - <function>imap_open</function> for the format of - <parameter>mbox</parameter>. + <simplelist> + <member><function>imap_createmailbox</function></member> + <member><function>imap_renamemailbox</function></member> + <member> + <function>imap_open</function> for the format of + <parameter>mbox</parameter> + </member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-errors.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-errors.xml diff -u phpdoc/en/reference/imap/functions/imap-errors.xml:1.7 phpdoc/en/reference/imap/functions/imap-errors.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-errors.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-errors.xml Mon Jan 15 00:05:58 2007 @@ -1,26 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imap-errors"> <refnamediv> <refname>imap_errors</refname> - <refpurpose>This function returns all of the IMAP errors (if any) that have occurred during this page request or since the error stack was reset</refpurpose> + <refpurpose>Returns all of the IMAP errors that have</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_errors</methodname> <void/> </methodsynopsis> <para> + Gets all of the IMAP errors (if any) that have occurred during this page + request or since the error stack was reset. + </para> + <para> + When <function>imap_errors</function> is called, the error stack is + subsequently cleared. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> This function returns an array of all of the IMAP error messages generated since the last <function>imap_errors</function> call, or the beginning of the page. Returns &false; if no error messages are - available. When <function>imap_errors</function> is called, the error - stack is subsequently cleared. + available. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_last_error</function>&listendand; - <function>imap_alerts</function> + <simplelist> + <member><function>imap_last_error</function></member> + <member><function>imap_alerts</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-expunge.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-expunge.xml diff -u phpdoc/en/reference/imap/functions/imap-expunge.xml:1.4 phpdoc/en/reference/imap/functions/imap-expunge.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-expunge.xml:1.4 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-expunge.xml Mon Jan 15 00:05:58 2007 @@ -1,22 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-expunge"> <refnamediv> <refname>imap_expunge</refname> <refpurpose>Delete all messages marked for deletion</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <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 - for deletion by <function>imap_delete</function>, - <function>imap_mail_move</function>, or + Deletes all the messages marked for deletion by + <function>imap_delete</function>, <function>imap_mail_move</function>, or <function>imap_setflag_full</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns &true;. </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetch-overview.xml?r1=1.11&r2=1.12&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.11 phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.12 --- phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.11 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-fetch-overview.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry id="function.imap-fetch-overview"> <refnamediv> <refname>imap_fetch_overview</refname> <refpurpose>Read an overview of the information in the headers of the given message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_fetch_overview</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -16,10 +16,43 @@ <para> This function fetches mail headers for the given <parameter>sequence</parameter> and returns an overview of their - contents. <parameter>sequence</parameter> will contain a sequence - of message indices or UIDs, if <parameter>flags</parameter> - contains FT_UID. The returned value is an array of objects - describing one message header each: + contents. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>sequence</parameter></term> + <listitem> + <para> + A message sequence description. You can enumerate desired messages + with the <literal>X,Y</literal> syntax, or retrieve all messages + within an interval with the <literal>X:Y</literal> syntax + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + <parameter>sequence</parameter> will contain a sequence of message + indices or UIDs, if this parameter is set to + <constant>FT_UID</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of objects describing one message header each. + The object will only define a property if it exists. The possible + properties are: <itemizedlist> <listitem> <simpara> @@ -103,23 +136,26 @@ </listitem> </itemizedlist> </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_fetch_overview</function> example</title> <programlisting role="php"> <![CDATA[ <?php -$mbox = imap_open("{imap.example.org:143}", "username", "password") +$mbox = imap_open("{imap.example.org:143}INBOX", "username", "password") or die("can't connect: " . imap_last_error()); -$overview = imap_fetch_overview($mbox, "2,4:6", 0); +$MC = imap_check($mbox); -if (is_array($overview)) { - foreach ($overview as $val) { - echo "$val->msgno - $val->date - $val->subject\n"; - } +// Fetch an overview for all messages in INBOX +$result = imap_fetch_overview($mbox,"1:{$MC->Nmsgs}",0); +foreach ($result => $overview) { + echo "#{$overview->msgno} ({$overview->date}) - From: {$overview->from} + {$overview->subject}\n"; } - imap_close($mbox); ?> ]]> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetchbody.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-fetchbody.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.6 phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-fetchbody.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <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> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_fetchbody</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -15,38 +15,75 @@ <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. + Fetch of a particular section of the body of the specified messages. + Body parts are not decoded by this function. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <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> + <variablelist> + &imap.imap-stream.description; + <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> + Returns a particular section of the body of the specified messages as a + text string. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_fetchstructure</function>. + <simplelist> + <member><function>imap_fetchstructure</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetchheader.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-fetchheader.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.7 phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-fetchheader.xml Mon Jan 15 00:05:58 2007 @@ -1,49 +1,75 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imap-fetchheader"> <refnamediv> <refname>imap_fetchheader</refname> <refpurpose>Returns header for a message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_fetchheader</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>msgno</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function causes a fetch of the complete, unfiltered - <ulink url="&url.rfc;2822">RFC2822</ulink> - format header of the specified message as a text string and - returns that text string. + This function causes a fetch of the complete, unfiltered <ulink + url="&url.rfc;2822">RFC2822</ulink> format header of the specified + message. </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>options</parameter></term> + <listitem> + <para> + The possible <parameter>options</parameter> are: + <itemizedlist> + <listitem> + <simpara> + <constant>FT_UID</constant> - The <parameter>msgno</parameter> + argument is a UID + </simpara> + </listitem> + <listitem> + <simpara> + <constant>FT_INTERNAL</constant> - The return string + is in "internal" format, without any attempt to + canonicalize to CRLF newlines + </simpara> + </listitem> + <listitem> + <simpara> + <constant>FT_PREFETCHTEXT</constant> - The RFC822.TEXT + should be pre-fetched at the same time. This avoids an + extra RTT on an IMAP connection if a full message text is + desired (e.g. in a "save to local file" operation) + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The <parameter>options</parameter> are: - <itemizedlist> - <listitem> - <simpara> - <constant>FT_UID</constant> - The <parameter>msgno</parameter> - argument is a UID - </simpara> - </listitem> - <listitem> - <simpara> - <constant>FT_INTERNAL</constant> - The return string - is in "internal" format, without any attempt to - canonicalize to CRLF newlines - </simpara> - </listitem> - <listitem> - <simpara> - <constant>FT_PREFETCHTEXT</constant> - The RFC822.TEXT - should be pre-fetched at the same time. This avoids an - extra RTT on an IMAP connection if a full message text is - desired (e.g. in a "save to local file" operation) - </simpara> - </listitem> - </itemizedlist> + Returns the header of the specified message as a text string. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetchstructure.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-fetchstructure.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchstructure.xml:1.8 phpdoc/en/reference/imap/functions/imap-fetchstructure.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-fetchstructure.xml:1.8 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-fetchstructure.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imap-fetchstructure"> <refnamediv> <refname>imap_fetchstructure</refname> <refpurpose>Read the structure of a particular message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>imap_fetchstructure</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -14,14 +14,42 @@ <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function fetches all the structured information for a given - message. The optional <parameter>options</parameter> parameter only - has a single option, <parameter>FT_UID</parameter>, which tells - the function to treat the <parameter>msg_number</parameter> - argument as a <parameter>UID</parameter>. The returned object - includes the envelope, internal date, size, flags and body - structure along with a similar object for each mime - attachment. The structure of the returned objects is as follows: + Fetches all the structured information for a given message. + </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>options</parameter></term> + <listitem> + <para> + This optional parameter only has a single option, + <constant>FT_UID</constant>, which tells the function to treat the + <parameter>msg_number</parameter> argument as a + <literal>UID</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object includes the envelope, internal date, size, flags and + body structure along with a similar object for each mime attachment. The + structure of the returned objects is as follows: </para> <para> <table> @@ -139,8 +167,13 @@ </tgroup> </table> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_fetchbody</function>. + <simplelist> + <member><function>imap_fetchbody</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-get-quota.xml?r1=1.16&r2=1.17&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-get-quota.xml diff -u phpdoc/en/reference/imap/functions/imap-get-quota.xml:1.16 phpdoc/en/reference/imap/functions/imap-get-quota.xml:1.17 --- phpdoc/en/reference/imap/functions/imap-get-quota.xml:1.16 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-get-quota.xml Mon Jan 15 00:05:58 2007 @@ -1,40 +1,66 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.16 $ --> +<!-- $Revision: 1.17 $ --> <refentry id="function.imap-get-quota"> <refnamediv> <refname>imap_get_quota</refname> <refpurpose>Retrieve the quota level settings, and usage statics per mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_get_quota</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> </methodsynopsis> <para> + Retrieve the quota level settings, and usage statics per mailbox. + </para> + <para> + For a non-admin user version of this function, + please see the <function>imap_get_quotaroot</function> function of PHP. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>quota_root</parameter></term> + <listitem> + <para> + <parameter>quota_root</parameter> should normally be in the form of + <literal>user.name</literal> where name is the mailbox you wish to + retrieve information about. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns an array with integer values limit and usage for the given mailbox. The value of limit represents the total amount of space allowed for this mailbox. The usage value represents the mailboxes current level of capacity. Will return &false; in the case of failure. </para> <para> - This function is currently only available to users of the c-client2000 - or greater library. - </para> - <para> - NOTE: For this function to work, the mail stream is required to be opened - as the mail-admin user. For a non-admin user version of this function, - please see the <function>imap_get_quotaroot</function> function of PHP. + As of PHP 4.3, the function more properly reflects the + functionality as dictated by the <ulink url="&url.rfc;2087">RFC2087</ulink>. + The array return value has changed to support an unlimited number of returned + resources (i.e. messages, or sub-folders) with each named resource receiving + an individual array key. Each key value then contains an another array with + the usage and limit values within it. </para> <para> - <parameter>imap_stream</parameter> should be the value returned from - an <function>imap_open</function> call. NOTE: This stream is required - to be opened as the mail admin user for the get_quota function to work. - <parameter>quota_root</parameter> should normally be in the form of - user.name where name is the mailbox you wish to retrieve information - about. + For backwards compatibility reasons, the original access methods are + still available for use, although it is suggested to update. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_get_quota</function> example</title> @@ -57,22 +83,8 @@ </example> </para> <para> - As of PHP 4.3, the function more properly reflects the - functionality as dictated by the <ulink url="&url.rfc;2087">RFC2087</ulink>. - The array return value has changed to support an unlimited number of returned resources (i.e. - messages, or sub-folders) with each named resource receiving an individual - array key. Each key value then contains an another array with the usage - and limit values within it. The example below shows the updated returned - output. - </para> - <para> - For backwards compatibility reasons, the original access methods are - still available for use, although it is suggested to update. - </para> - <para> <example> - <title><function>imap_get_quota</function> 4.3 or greater - example</title> + <title><function>imap_get_quota</function> 4.3 or greater example</title> <programlisting role="php"> <![CDATA[ <?php @@ -98,10 +110,26 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <para> + This function is currently only available to users of the c-client2000 + or greater library. + </para> + <para> + The given <parameter>imap_stream</parameter> must be opened as the mail + administrator, other wise this function will fail. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_open</function>, - <function>imap_set_quota</function> and - <function>imap_get_quotaroot</function>. + <simplelist> + <member><function>imap_open</function></member> + <member><function>imap_set_quota</function></member> + <member><function>imap_get_quotaroot</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml diff -u phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml:1.7 phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml Mon Jan 15 00:05:58 2007 @@ -1,40 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imap-get-quotaroot"> <refnamediv> <refname>imap_get_quotaroot</refname> <refpurpose>Retrieve the quota settings per user</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_get_quotaroot</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> </methodsynopsis> <para> - Returns an array of integer values pertaining to the specified user - mailbox. All values contain a key based upon the resource name, and a - corresponding array with the usage and limit values within. + Retrieve the quota settings per user. The limit value represents the total + amount of space allowed for this user's total mailbox usage. The usage + value represents the user's current total mailbox capacity. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The limit value represents the total amount of space - allowed for this user's total mailbox usage. The usage value represents - the user's current total mailbox capacity. This function will return - &false; in the case of call failure, and an array of information about - the connection upon an un-parsable response from the server. + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>quota_root</parameter></term> + <listitem> + <para> + <parameter>quota_root</parameter> should normally be in the form of + which mailbox (i.e. INBOX). + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This function is currently only available to users of the c-client2000 - or greater library. + Returns an array of integer values pertaining to the specified user + mailbox. All values contain a key based upon the resource name, and a + corresponding array with the usage and limit values within. </para> <para> - <parameter>imap_stream</parameter> should be the value returned from - an <function>imap_open</function> call. This stream should be opened - as the user whose mailbox you wish to check. - <parameter>quota_root</parameter> should normally be in the form of - which mailbox (i.e. INBOX). + This function will return &false; in the case of call failure, and an + array of information about the connection upon an un-parsable response + from the server. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_get_quotaroot</function> example</title> @@ -64,10 +79,26 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <para> + This function is currently only available to users of the c-client2000 + or greater library. + </para> + <para> + The <parameter>imap_stream</parameter> should be opened as the user whose + mailbox you wish to check. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_open</function>, - <function>imap_set_quota</function> and - <function>imap_get_quota</function>. + <simplelist> + <member><function>imap_open</function></member> + <member><function>imap_set_quota</function></member> + <member><function>imap_get_quota</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-getacl.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-getacl.xml diff -u phpdoc/en/reference/imap/functions/imap-getacl.xml:1.4 phpdoc/en/reference/imap/functions/imap-getacl.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-getacl.xml:1.4 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-getacl.xml Mon Jan 15 00:05:58 2007 @@ -1,25 +1,49 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-getacl"> <refnamediv> <refname>imap_getacl</refname> <refpurpose>Gets the ACL for a given mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_getacl</methodname> - <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <para> This function is currently only available to users of the c-client2000 or greater library. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_setacl</function>. + <simplelist> + <member><function>imap_setacl</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-getmailboxes.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-getmailboxes.xml diff -u phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.9 phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.9 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-getmailboxes.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imap-getmailboxes"> <refnamediv> <refname>imap_getmailboxes</refname> <refpurpose>Read the list of mailboxes, returning detailed information on each one</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_getmailboxes</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -14,6 +14,48 @@ <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> <para> + Gets information on the mailboxes. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>ref</parameter></term> + <listitem> + <para> + <parameter>ref</parameter> should normally be just the server + specification as described in <function>imap_open</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + Specifies where in the mailbox hierarchy to start searching. + </para> + <para> + There are two special characters you can pass as part of the + <parameter>pattern</parameter>: '*' and '%'. '*' means to return + all mailboxes. If you pass <parameter>pattern</parameter> as '*', + you will get a list of the entire mailbox hierarchy. '%' means to + return the current level only. '%' as the + <parameter>pattern</parameter> parameter will return only the top + level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox + in the ~/mail directory, but none in subfolders of that + directory. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns an array of objects containing mailbox information. Each object has the attributes <parameter>name</parameter>, specifying the full name of the mailbox; <parameter>delimiter</parameter>, @@ -48,29 +90,9 @@ </listitem> </itemizedlist> </para> - <para> - Mailbox names containing international Characters outside the - printable ASCII range will be encoded and may be decoded by - <function>imap_utf7_decode</function>. - </para> - <para> - <parameter>ref</parameter> should normally be just the server - specification as described in <function>imap_open</function>, and - <parameter>pattern</parameter> specifies where in the mailbox - hierarchy to start searching. If you want all mailboxes, pass - '*' for <parameter>pattern</parameter>. - </para> - <para> - There are two special characters you can pass as part of the - <parameter>pattern</parameter>: '*' and '%'. '*' means to return - all mailboxes. If you pass <parameter>pattern</parameter> as '*', - you will get a list of the entire mailbox hierarchy. '%' means to - return the current level only. '%' as the - <parameter>pattern</parameter> parameter will return only the top - level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox - in the ~/mail directory, but none in subfolders of that - directory. - </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_getmailboxes</function> example</title> @@ -98,8 +120,13 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_getsubscribed</function>. + <simplelist> + <member><function>imap_getsubscribed</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-getsubscribed.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-getsubscribed.xml diff -u phpdoc/en/reference/imap/functions/imap-getsubscribed.xml:1.4 phpdoc/en/reference/imap/functions/imap-getsubscribed.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-getsubscribed.xml:1.4 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-getsubscribed.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-getsubscribed"> <refnamediv> <refname>imap_getsubscribed</refname> <refpurpose>List all the subscribed mailboxes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_getsubscribed</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -14,11 +14,87 @@ <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> <para> - This function is identical to - <function>imap_getmailboxes</function>, except that it only + Gets information on the subscribeds mailboxes. + </para> + <para> + Identical to <function>imap_getmailboxes</function>, except that it only returns mailboxes that the user is subscribed to. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>ref</parameter></term> + <listitem> + <para> + <parameter>ref</parameter> should normally be just the server + specification as described in <function>imap_open</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + Specifies where in the mailbox hierarchy to start searching. + </para> + <para> + There are two special characters you can pass as part of the + <parameter>pattern</parameter>: '*' and '%'. '*' means to return + all mailboxes. If you pass <parameter>pattern</parameter> as '*', + you will get a list of the entire mailbox hierarchy. '%' means to + return the current level only. '%' as the + <parameter>pattern</parameter> parameter will return only the top + level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox + in the ~/mail directory, but none in subfolders of that + directory. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of objects containing mailbox information. Each + object has the attributes <parameter>name</parameter>, specifying + the full name of the mailbox; <parameter>delimiter</parameter>, + which is the hierarchy delimiter for the part of the hierarchy + this mailbox is in; and + <parameter>attributes</parameter>. <parameter>Attributes</parameter> + is a bitmask that can be tested against: + <itemizedlist> + <listitem> + <simpara> + <constant>LATT_NOINFERIORS</constant> - This mailbox has no + "children" (there are no mailboxes below this one). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LATT_NOSELECT</constant> - This is only a container, + not a mailbox - you cannot open it. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LATT_MARKED</constant> - This mailbox is marked. + Only used by UW-IMAPD. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LATT_UNMARKED</constant> - This mailbox is not marked. + Only used by UW-IMAPD. + </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-headerinfo.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-headerinfo.xml diff -u phpdoc/en/reference/imap/functions/imap-headerinfo.xml:1.4 phpdoc/en/reference/imap/functions/imap-headerinfo.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-headerinfo.xml:1.4 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-headerinfo.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-headerinfo"> <refnamediv> <refname>imap_headerinfo</refname> <refpurpose>Read the header of the message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>imap_headerinfo</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -16,95 +16,263 @@ <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam> </methodsynopsis> <para> - This function returns an object of various header elements. + Gets information about the given message number by reading its headers. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <informalexample> - <literallayout> - remail, date, Date, subject, Subject, in_reply_to, message_id, - newsgroups, followup_to, references - -message flags: - Recent - 'R' if recent and seen, - 'N' if recent and not seen, - ' ' if not recent - Unseen - 'U' if not seen AND not recent, - ' ' if seen OR not seen and recent - Answered -'A' if answered, - ' ' if unanswered - Deleted - 'D' if deleted, - ' ' if not deleted - Draft - 'X' if draft, - ' ' if not draft - Flagged - 'F' if flagged, - ' ' if not flagged - -NOTE that the Recent/Unseen behavior is a little odd. If you want to -know if a message is Unseen, you must check for - -Unseen == 'U' || Recent == 'N' - -toaddress (full to: line, up to 1024 characters) - -to[] (returns an array of objects from the To line, containing): - personal - adl - mailbox - host - -fromaddress (full from: line, up to 1024 characters) - -from[] (returns an array of objects from the From line, containing): - personal - adl - mailbox - host - -ccaddress (full cc: line, up to 1024 characters) -cc[] (returns an array of objects from the Cc line, containing): - personal - adl - mailbox - host - -bccaddress (full bcc line, up to 1024 characters) -bcc[] (returns an array of objects from the Bcc line, containing): - personal - adl - mailbox - host - -reply_toaddress (full reply_to: line, up to 1024 characters) -reply_to[] (returns an array of objects from the Reply_to line, -containing): - personal - adl - mailbox - host - -senderaddress (full sender: line, up to 1024 characters) -sender[] (returns an array of objects from the sender line, containing): - personal - adl - mailbox - host - -return_path (full return-path: line, up to 1024 characters) -return_path[] (returns an array of objects from the return_path line, -containing): - personal - adl - mailbox - host - -udate (mail message date in unix time) - -fetchfrom (from line formatted to fit <parameter>fromlength</parameter> -characters) - -fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter> characters) - </literallayout> - </informalexample> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>msg_number</parameter></term> + <listitem> + <para> + The message number + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fromlength</parameter></term> + <listitem> + <para> + Number of characters for the <literal>fetchfrom</literal> property. + Must be greater than or equal to zero. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>subjectlength</parameter></term> + <listitem> + <para> + Number of characters for the <literal>fetchsubject</literal> property + Must be greater than or equal to zero. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>defaulthost</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the information in an object with following properties: + <itemizedlist> + <listitem> + <simpara> + toaddress - full to: line, up to 1024 characters + </simpara> + </listitem> + <listitem> + <simpara> + to - an array of objects from the To: line, with the following + properties: <literal>personal</literal>, <literal>adl</literal>, + <literal>mailbox</literal>, and <literal>host</literal> + </simpara> + </listitem> + <listitem> + <simpara> + fromaddress - full from: line, up to 1024 characters + </simpara> + </listitem> + <listitem> + <simpara> + from - an array of objects from the From: line, with the following + properties: <literal>personal</literal>, <literal>adl</literal>, + <literal>mailbox</literal>, and <literal>host</literal> + </simpara> + </listitem> + <listitem> + <simpara> + ccaddress - full cc: line, up to 1024 characters + </simpara> + </listitem> + <listitem> + <simpara> + cc - an array of objects from the Cc: line, with the following + properties: <literal>personal</literal>, <literal>adl</literal>, + <literal>mailbox</literal>, and <literal>host</literal> + </simpara> + </listitem> + <listitem> + <simpara> + bccaddress - full bcc: line, up to 1024 characters + </simpara> + </listitem> + <listitem> + <simpara> + bcc - an array of objects from the Bcc: line, with the following + properties: <literal>personal</literal>, <literal>adl</literal>, + <literal>mailbox</literal>, and <literal>host</literal> + </simpara> + </listitem> + <listitem> + <simpara> + reply_toaddress - full Reply-To: line, up to 1024 characters + </simpara> + </listitem> + <listitem> + <simpara> + reply_to - an array of objects from the Reply-To: line, with the following + properties: <literal>personal</literal>, <literal>adl</literal>, + <literal>mailbox</literal>, and <literal>host</literal> + </simpara> + </listitem> + <listitem> + <simpara> + senderaddress - full sender: line, up to 1024 characters + </simpara> + </listitem> + <listitem> + <simpara> + sender - an array of objects from the Sender: line, with the following + properties: <literal>personal</literal>, <literal>adl</literal>, + <literal>mailbox</literal>, and <literal>host</literal> + </simpara> + </listitem> + <listitem> + <simpara> + return_pathaddress - full Return-Path: line, up to 1024 characters + </simpara> + </listitem> + <listitem> + <simpara> + return_path - an array of objects from the Return-Path: line, with the + following properties: <literal>personal</literal>, + <literal>adl</literal>, <literal>mailbox</literal>, and + <literal>host</literal> + </simpara> + </listitem> + <listitem> + <simpara> + remail - + </simpara> + </listitem> + <listitem> + <simpara> + date - The message date as found in its headers + </simpara> + </listitem> + <listitem> + <simpara> + Date - Same as date + </simpara> + </listitem> + <listitem> + <simpara> + subject - The message subject + </simpara> + </listitem> + <listitem> + <simpara> + Subject - Same a subject + </simpara> + </listitem> + <listitem> + <simpara> + in_reply_to - + </simpara> + </listitem> + <listitem> + <simpara> + message_id - + </simpara> + </listitem> + <listitem> + <simpara> + newsgroups - + </simpara> + </listitem> + <listitem> + <simpara> + followup_to - + </simpara> + </listitem> + <listitem> + <simpara> + references - + </simpara> + </listitem> + <listitem> + <simpara> + Recent - <literal>R</literal> if recent and seen, <literal>N</literal> + if recent and not seen, ' ' if not recent. + </simpara> + </listitem> + <listitem> + <simpara> + Unseen - <literal>U</literal> if not seen AND not recent, ' ' if seen + OR not seen and recent + </simpara> + </listitem> + <listitem> + <simpara> + Flagged - <literal>F</literal> if flagged,, ' ' if not flagged + </simpara> + </listitem> + <listitem> + <simpara> + Answered - <literal>A</literal> if answered, ' ' if unanswered + </simpara> + </listitem> + <listitem> + <simpara> + Deleted - <literal>D</literal> if deleted, ' ' if not deleted + </simpara> + </listitem> + <listitem> + <simpara> + Draft - <literal>X</literal> if draft, ' ' if not draft + </simpara> + </listitem> + <listitem> + <simpara> + Msgno - The message number + </simpara> + </listitem> + <listitem> + <simpara> + MailDate - + </simpara> + </listitem> + <listitem> + <simpara> + Size - The message size + </simpara> + </listitem> + <listitem> + <simpara> + udate - mail message date in unix time + </simpara> + </listitem> + <listitem> + <simpara> + fetchfrom - from line formatted to fit <parameter>fromlength</parameter> + characters + </simpara> + </listitem> + <listitem> + <simpara> + fetchsubject - subject line formatted to fit + <parameter>subjectlength</parameter> characters + </simpara> + </listitem> + </itemizedlist> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imap_fetch_overview</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-headers.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-headers.xml diff -u phpdoc/en/reference/imap/functions/imap-headers.xml:1.4 phpdoc/en/reference/imap/functions/imap-headers.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-headers.xml:1.4 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-headers.xml Mon Jan 15 00:05:58 2007 @@ -1,17 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-headers"> <refnamediv> <refname>imap_headers</refname> <refpurpose>Returns headers for all messages in a mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_headers</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> + Returns headers for all messages in a mailbox. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns an array of string formatted with header info. One element per mail message. </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-last-error.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-last-error.xml diff -u phpdoc/en/reference/imap/functions/imap-last-error.xml:1.5 phpdoc/en/reference/imap/functions/imap-last-error.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-last-error.xml:1.5 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-last-error.xml Mon Jan 15 00:05:58 2007 @@ -1,25 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imap-last-error"> <refnamediv> <refname>imap_last_error</refname> - <refpurpose>This function returns the last IMAP error (if any) that occurred during this page request</refpurpose> + <refpurpose>Gets the last IMAP error that occurred during this page request</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_last_error</methodname> <void/> </methodsynopsis> <para> - This function returns the full text of the last IMAP error - message that occurred on the current page. The error stack is - untouched; calling <function>imap_last_error</function> - subsequently, with no intervening errors, will return the same - error. Returns &false; if no error messages are available. + Gets the full text of the last IMAP error message that occurred on the + current page. The error stack is untouched; calling + <function>imap_last_error</function> subsequently, with no intervening + errors, will return the same error. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the full text of the last IMAP error message that occurred on the + current page. Returns &false; if no error messages are available. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_errors</function>. + <simplelist> + <member><function>imap_errors</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-list.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-list.xml diff -u phpdoc/en/reference/imap/functions/imap-list.xml:1.7 phpdoc/en/reference/imap/functions/imap-list.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-list.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-list.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imap-list"> <refnamediv> <refname>imap_list</refname> <refpurpose>Read the list of mailboxes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_list</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -14,10 +14,53 @@ <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> <para> + Read the list of mailboxes. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>ref</parameter></term> + <listitem> + <para> + <parameter>ref</parameter> should normally be just the server + specification as described in <function>imap_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + Specifies where in the mailbox hierarchy to start searching. + </para> + <para> + There are two special characters you can pass as part of the + <parameter>pattern</parameter>: '*' and '%'. '*' means to return + all mailboxes. If you pass <parameter>pattern</parameter> as '*', + you will get a list of the entire mailbox hierarchy. '%' means to + return the current level only. '%' as the + <parameter>pattern</parameter> parameter will return only the top + level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox + in the ~/mail directory, but none in subfolders of that + directory. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <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> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_list</function> example</title> @@ -30,7 +73,7 @@ $list = imap_list($mbox, "{imap.example.org}", "*"); if (is_array($list)) { foreach ($list as $val) { - echo imap_utf7_decode($val) . "<br />\n"; + echo imap_utf7_decode($val) . "\n"; } } else { echo "imap_list failed: " . imap_last_error() . "\n"; @@ -42,8 +85,13 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_getmailboxes</function>. + <simplelist> + <member><function>imap_getmailboxes</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-listscan.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-listscan.xml diff -u phpdoc/en/reference/imap/functions/imap-listscan.xml:1.3 phpdoc/en/reference/imap/functions/imap-listscan.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-listscan.xml:1.3 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-listscan.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <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> + <refpurpose>Returns the list of mailboxes that matches the given text</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_listscan</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -23,9 +23,64 @@ but it will additionally check for the presence of the string <parameter>content</parameter> inside the mailbox data. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>ref</parameter></term> + <listitem> + <para> + <parameter>ref</parameter> should normally be just the server + specification as described in <function>imap_open</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + Specifies where in the mailbox hierarchy to start searching. + </para> + <para> + There are two special characters you can pass as part of the + <parameter>pattern</parameter>: '*' and '%'. '*' means to return + all mailboxes. If you pass <parameter>pattern</parameter> as '*', + you will get a list of the entire mailbox hierarchy. '%' means to + return the current level only. '%' as the + <parameter>pattern</parameter> parameter will return only the top + level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox + in the ~/mail directory, but none in subfolders of that + directory + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>content</parameter></term> + <listitem> + <para> + The searched string + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array containing the names of the mailboxes that have + <parameter>content</parameter> in the text of the mailbox. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See <function>imap_getmailboxes</function> for a description - of <parameter>ref</parameter> and <parameter>pattern</parameter>. + <simplelist> + <member><function>imap_listmailbox</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-lsub.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-lsub.xml diff -u phpdoc/en/reference/imap/functions/imap-lsub.xml:1.3 phpdoc/en/reference/imap/functions/imap-lsub.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-lsub.xml:1.3 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-lsub.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.imap-lsub"> <refnamediv> <refname>imap_lsub</refname> <refpurpose>List all the subscribed mailboxes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_lsub</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -14,8 +14,49 @@ <methodparam><type>string</type><parameter>pattern</parameter></methodparam> </methodsynopsis> <para> - Returns an array of all the mailboxes that you have - subscribed. + Gets an array of all the mailboxes that you have subscribed. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>ref</parameter></term> + <listitem> + <para> + <parameter>ref</parameter> should normally be just the server + specification as described in <function>imap_open</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pattern</parameter></term> + <listitem> + <para> + Specifies where in the mailbox hierarchy to start searching. + </para> + <para> + There are two special characters you can pass as part of the + <parameter>pattern</parameter>: '*' and '%'. '*' means to return + all mailboxes. If you pass <parameter>pattern</parameter> as '*', + you will get a list of the entire mailbox hierarchy. '%' means to + return the current level only. '%' as the + <parameter>pattern</parameter> parameter will return only the top + level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox + in the ~/mail directory, but none in subfolders of that + directory. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of all the subscribed mailboxes. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mail-compose.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mail-compose.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.7 phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-mail-compose.xml Mon Jan 15 00:05:58 2007 @@ -1,19 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imap-mail-compose"> <refnamediv> <refname>imap_mail_compose</refname> <refpurpose>Create a MIME message based on given envelope and body sections</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_mail_compose</methodname> <methodparam><type>array</type><parameter>envelope</parameter></methodparam> <methodparam><type>array</type><parameter>body</parameter></methodparam> </methodsynopsis> <para> + Create a MIME message based on the given <parameter>envelope</parameter> + and <parameter>body</parameter> sections. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>envelope</parameter></term> + <listitem> + <para> + An associative array of headers fields + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>body</parameter></term> + <listitem> + <para> + An indexed array of bodies + </para> + <para> + A body is an associative array which can consist of the following + keys: "type", "encoding", "subtype", "description" and "contents.data" + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the MIME message. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_mail_compose</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mail-copy.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mail-copy.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.6 phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-mail-copy.xml Mon Jan 15 00:05:58 2007 @@ -1,45 +1,83 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imap-mail-copy"> <refnamediv> <refname>imap_mail_copy</refname> <refpurpose>Copy specified messages to a mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <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><type>string</type><parameter>mailbox</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> Copies mail messages specified by <parameter>msglist</parameter> - to specified mailbox. &return.success;. + to specified mailbox. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>msglist</parameter> is a range not just message - numbers (as described in <ulink url="&url.rfc;2060">RFC2060</ulink>). + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>msglist</parameter></term> + <listitem> + <para> + <parameter>msglist</parameter> is a range not just message + numbers (as described in <ulink url="&url.rfc;2060">RFC2060</ulink>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + <parameter>options</parameter> is a bitmask of one or more of + <itemizedlist> + <listitem> + <simpara> + <constant>CP_UID</constant> - the sequence numbers contain UIDS + </simpara> + </listitem> + <listitem> + <simpara> + <constant>CP_MOVE</constant> - Delete the messages from + the current mailbox after copying + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>options</parameter> is a bitmask of one or more of - <itemizedlist> - <listitem> - <simpara> - <constant>CP_UID</constant> - the sequence numbers contain UIDS - </simpara> - </listitem> - <listitem> - <simpara> - <constant>CP_MOVE</constant> - Delete the messages from - the current mailbox after copying - </simpara> - </listitem> - </itemizedlist> + &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_mail_move</function>. + <simplelist> + <member><function>imap_mail_move</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mail-move.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mail-move.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.7 phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-mail-move.xml Mon Jan 15 00:05:58 2007 @@ -1,39 +1,77 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imap-mail-move"> <refnamediv> <refname>imap_mail_move</refname> <refpurpose>Move specified messages to a mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <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><type>string</type><parameter>mailbox</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - Moves mail messages specified by <parameter>msglist</parameter> - to specified mailbox <parameter>mbox</parameter>. &return.success;. + Moves mail messages specified by <parameter>msglist</parameter> to the + specified <parameter>mailbox</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>msglist</parameter> is a range not just message numbers - (as described in <ulink url="&url.rfc;2060">RFC2060</ulink>). + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>msglist</parameter></term> + <listitem> + <para> + <parameter>msglist</parameter> is a range not just message numbers + (as described in <ulink url="&url.rfc;2060">RFC2060</ulink>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + <parameter>options</parameter> is a bitmask and may contain the single option: + <itemizedlist> + <listitem> + <simpara> + <constant>CP_UID</constant> - the sequence numbers contain UIDS + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>options</parameter> is a bitmask and may contain the single option: - <itemizedlist> - <listitem> - <simpara> - <constant>CP_UID</constant> - the sequence numbers contain UIDS - </simpara> - </listitem> - </itemizedlist> + &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_mail_copy</function>. + <simplelist> + <member><function>imap_mail_copy</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mail.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mail.xml diff -u phpdoc/en/reference/imap/functions/imap-mail.xml:1.7 phpdoc/en/reference/imap/functions/imap-mail.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-mail.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-mail.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imap-mail"> <refnamediv> <refname>imap_mail</refname> <refpurpose>Send an email message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_mail</methodname> <methodparam><type>string</type><parameter>to</parameter></methodparam> @@ -19,20 +19,82 @@ </methodsynopsis> <para> This function allows sending of emails with correct handling of - Cc and Bcc receivers. &return.success;. + Cc and Bcc receivers. </para> <para> The parameters <parameter>to</parameter>, <parameter>cc</parameter> and <parameter>bcc</parameter> are all strings and are all parsed as <ulink url="&url.rfc;822">RFC822</ulink> address lists. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The receivers specified in <parameter>bcc</parameter> will get the - mail, but are excluded from the headers. + <variablelist> + <varlistentry> + <term><parameter>to</parameter></term> + <listitem> + <para> + The receiver + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>subject</parameter></term> + <listitem> + <para> + The mail subject + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>message</parameter></term> + <listitem> + <para> + The mail body + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>additional_headers</parameter></term> + <listitem> + <para> + As string with additional headers to be set on the mail + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>cc</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bcc</parameter></term> + <listitem> + <para> + The receivers specified in <parameter>bcc</parameter> will get the + mail, but are excluded from the headers. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rpath</parameter></term> + <listitem> + <para> + Use this parameter to specify return path upon mail delivery failure. + This is useful when using PHP as a mail client for multiple users. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Use the <parameter>rpath</parameter> parameter to specify return path. - This is useful when using PHP as a mail client for multiple users. + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml diff -u phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml:1.6 phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml Mon Jan 15 00:05:58 2007 @@ -1,29 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imap-mailboxmsginfo"> <refnamediv> <refname>imap_mailboxmsginfo</refname> <refpurpose>Get information about the current mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>imap_mailboxmsginfo</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> - Returns information about the current mailbox. Returns &false; on - failure. + Checks the current mailbox status on the server. It is similar to + <function>imap_status</function>, but will additionally sum up the size of + all messages in the mailbox, which will take some additional time to + execute. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The <function>imap_mailboxmsginfo</function> function checks the - current mailbox status on the server. It is similar to - <function>imap_status</function>, but will additionally sum up the - size of all messages in the mailbox, which will take some additional - time to execute. It returns the information - in an object with following properties. + <variablelist> + &imap.imap-stream.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> + Returns the information in an object with following properties: <table> <title>Mailbox properties</title> <tgroup cols="2"> @@ -65,6 +71,12 @@ </table> </para> <para> + Returns &false; on failure. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title><function>imap_mailboxmsginfo</function> example</title> <programlisting role="php"> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml diff -u phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml:1.10 phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml:1.11 --- phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml:1.10 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml Mon Jan 15 00:05:58 2007 @@ -1,26 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imap-mime-header-decode"> <refnamediv> <refname>imap_mime_header_decode</refname> <refpurpose>Decode MIME header elements</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_mime_header_decode</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - <function>imap_mime_header_decode</function> function decodes - MIME message header extensions that are non ASCII text - (see <ulink url="&url.rfc;2047">RFC2047</ulink>). - The decoded elements are returned in an array of objects, - where each object has two properties, "charset" and "text". + Decodes MIME message header extensions that are non ASCII text (see <ulink + url="&url.rfc;2047">RFC2047</ulink>). + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The MIME text + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The decoded elements are returned in an array of objects, where each + object has two properties, <literal>charset</literal> and + <literal>text</literal>. + </para> + <para> If the element hasn't been encoded, and in other words is in - plain US-ASCII,the "charset" property of that element is set to - "default". + plain US-ASCII, the <literal>charset</literal> property of that element is + set to <literal>default</literal>. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_mime_header_decode</function> example</title> @@ -37,6 +62,16 @@ ?> ]]> </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Charset: ISO-8859-1 +Text: Keld Jørn Simonsen + +Charset: default +Text: <keld@example.com> +]]> + </screen> </example> </para> <para> @@ -44,8 +79,13 @@ element had previously been encoded with ISO-8859-1, and the second element would be plain US-ASCII. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_utf8</function>. + <simplelist> + <member><function>imap_utf8</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-msgno.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-msgno.xml diff -u phpdoc/en/reference/imap/functions/imap-msgno.xml:1.5 phpdoc/en/reference/imap/functions/imap-msgno.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-msgno.xml:1.5 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-msgno.xml Mon Jan 15 00:05:58 2007 @@ -1,24 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imap-msgno"> <refnamediv> <refname>imap_msgno</refname> - <refpurpose>This function returns the message sequence number for the given UID</refpurpose> + <refpurpose>Gets the message sequence number for the given UID</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imap_msgno</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>int</type><parameter>uid</parameter></methodparam> </methodsynopsis> <para> - This function returns the message sequence number for the given - <parameter>uid</parameter>. It is the inverse of - <function>imap_uid</function>. + Returns the message sequence number for the given + <parameter>uid</parameter>. </para> <para> - See also <function>imap_uid</function>. + This function is the inverse of <function>imap_uid</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>uid</parameter></term> + <listitem> + <para> + The message UID + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the message sequence number for the given + <parameter>uid</parameter>. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imap_uid</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-num-msg.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-num-msg.xml diff -u phpdoc/en/reference/imap/functions/imap-num-msg.xml:1.4 phpdoc/en/reference/imap/functions/imap-num-msg.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-num-msg.xml:1.4 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-num-msg.xml Mon Jan 15 00:05:58 2007 @@ -1,22 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-num-msg"> <refnamediv> <refname>imap_num_msg</refname> - <refpurpose>Gives the number of messages in the current mailbox</refpurpose> + <refpurpose>Gets the number of messages in the current mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imap_num_msg</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> - Return the number of messages in the current mailbox. + Gets the number of messages in the current mailbox. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Return the number of messages in the current mailbox, as an integer. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_num_recent</function> and - <function>imap_status</function>. + <simplelist> + <member><function>imap_num_recent</function></member> + <member><function>imap_status</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-num-recent.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-num-recent.xml diff -u phpdoc/en/reference/imap/functions/imap-num-recent.xml:1.4 phpdoc/en/reference/imap/functions/imap-num-recent.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-num-recent.xml:1.4 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-num-recent.xml Mon Jan 15 00:05:58 2007 @@ -1,23 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imap-num-recent"> <refnamediv> <refname>imap_num_recent</refname> - <refpurpose>Gives the number of recent messages in current - mailbox</refpurpose> + <refpurpose>Gets the number of recent messages in current mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imap_num_recent</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> </methodsynopsis> <para> - Returns the number of recent messages in the current mailbox. + Gets the number of recent messages in the current mailbox. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of recent messages in the current mailbox, as an + integer. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_num_msg</function> and - <function>imap_status</function>. + <simplelist> + <member><function>imap_num_msg</function></member> + <member><function>imap_status</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-open.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-open.xml diff -u phpdoc/en/reference/imap/functions/imap-open.xml:1.11 phpdoc/en/reference/imap/functions/imap-open.xml:1.12 --- phpdoc/en/reference/imap/functions/imap-open.xml:1.11 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-open.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry id="function.imap-open"> <refnamediv> <refname>imap_open</refname> <refpurpose>Open an IMAP stream to a mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imap_open</methodname> <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> @@ -15,198 +15,247 @@ <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - Returns an IMAP stream on success and &false; on error. This - function can also be used to open streams to POP3 and NNTP - servers, but some functions and features are only available - on IMAP servers. + Opens an IMAP stream to a <parameter>mailbox</parameter>. </para> <para> - A mailbox name consists of a server part and a mailbox path on - this server. The special name INBOX stands for the current users - personal mailbox. The server part, which is enclosed in '{' and - '}', consists of the servers name or ip address, an optional port - (prefixed by ':'), and an optional protocol specification (prefixed - by '/'). The server part is mandatory in all mailbox - parameters. Mailbox names that contain international characters - besides those in the printable ASCII space have to be encoded - with <function>imap_utf7_encode</function>. - </para> - <para> - All names which start with <literal>{</literal> are remote names, and are - in the form <literal>"{" remote_system_name [":" port] [flags] "}" - [mailbox_name]</literal> where: - <itemizedlist> - <listitem> - <simpara> - <literal>remote_system_name</literal> - Internet domain name or - bracketed IP address of server. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>port</literal> - optional TCP port number, default is the - default port for that service - </simpara> - </listitem> - <listitem> - <simpara> - <literal>flags</literal> - optional flags, see following table. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>mailbox_name</literal> - remote mailbox name, default is INBOX - </simpara> - </listitem> - </itemizedlist> + This function can also be used to open streams to POP3 and NNTP servers, + but some functions and features are only available on IMAP servers. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <table> - <title>Optional flags for names</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Flag</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>/service=</literal><emphasis>service</emphasis></entry> - <entry>mailbox access service, default is "imap"</entry> - </row> - <row> - <entry><literal>/user=</literal><emphasis>user</emphasis></entry> - <entry>remote user name for login on the server</entry> - </row> - <row> - <entry><literal>/authuser=</literal><emphasis>user</emphasis></entry> - <entry>remote authentication user; if specified this is the user name - whose password is used (e.g. administrator)</entry> - </row> - <row> - <entry><literal>/anonymous</literal></entry> - <entry>remote access as anonymous user</entry> - </row> - <row> - <entry><literal>/debug</literal></entry> - <entry>record protocol telemetry in application's debug log</entry> - </row> - <row> - <entry><literal>/secure</literal></entry> - <entry>do not transmit a plaintext password over the network</entry> - </row> - <row> - <entry><literal>/imap</literal>, <literal>/imap2</literal>, - <literal>/imap2bis</literal>, <literal>/imap4</literal>, - <literal>/imap4rev1</literal></entry> - <entry>equivalent to /service=imap</entry> - </row> - <row> - <entry><literal>/pop3</literal></entry> - <entry>equivalent to /service=pop3</entry> - </row> - <row> - <entry><literal>/nntp</literal></entry> - <entry>equivalent to /service=nntp</entry> - </row> - <row> - <entry><literal>/norsh</literal></entry> - <entry>do not use rsh or ssh to establish a preauthenticated IMAP - session</entry> - </row> - <row> - <entry><literal>/ssl</literal></entry> - <entry>use the Secure Socket Layer to encrypt the session</entry> - </row> - <row> - <entry><literal>/validate-cert</literal></entry> - <entry>validate certificates from TLS/SSL server (this is the default - behavior)</entry> - </row> - <row> - <entry><literal>/novalidate-cert</literal></entry> - <entry>do not validate certificates from TLS/SSL server, needed if - server uses self-signed certificates</entry> - </row> - <row> - <entry><literal>/tls</literal></entry> - <entry>force use of start-TLS to encrypt the session, and reject - connection to servers that do not support it</entry> - </row> - <row> - <entry><literal>/notls</literal></entry> - <entry>do not do start-TLS to encrypt the session, even with servers - that support it</entry> - </row> - <row> - <entry><literal>/readonly</literal></entry> - <entry>request read-only mailbox open (IMAP only; ignored on NNTP, and - an error with SMTP and POP3)</entry> - </row> - </tbody> - </tgroup> - </table> + <variablelist> + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + A mailbox name consists of a server and a mailbox path on this server. + The special name <literal>INBOX</literal> stands for the current users + personal mailbox. Mailbox names that contain international characters + besides those in the printable ASCII space have to be encoded width + <function>imap_utf7_encode</function>. + </para> + <para> + The server part, which is enclosed in '{' and '}', consists of the servers + name or ip address, an optional port (prefixed by ':'), and an optional + protocol specification (prefixed by '/'). + </para> + <para> + The server part is mandatory in all mailbox + parameters. + </para> + <para> + All names which start with <literal>{</literal> are remote names, and are + in the form <literal>"{" remote_system_name [":" port] [flags] "}" + [mailbox_name]</literal> where: + <itemizedlist> + <listitem> + <simpara> + <literal>remote_system_name</literal> - Internet domain name or + bracketed IP address of server. + </simpara> + </listitem> + <listitem> + <simpara> + <literal>port</literal> - optional TCP port number, default is the + default port for that service + </simpara> + </listitem> + <listitem> + <simpara> + <literal>flags</literal> - optional flags, see following table. + </simpara> + </listitem> + <listitem> + <simpara> + <literal>mailbox_name</literal> - remote mailbox name, default is INBOX + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + <table> + <title>Optional flags for names</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Flag</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>/service=</literal><emphasis>service</emphasis></entry> + <entry>mailbox access service, default is "imap"</entry> + </row> + <row> + <entry><literal>/user=</literal><emphasis>user</emphasis></entry> + <entry>remote user name for login on the server</entry> + </row> + <row> + <entry><literal>/authuser=</literal><emphasis>user</emphasis></entry> + <entry>remote authentication user; if specified this is the user name + whose password is used (e.g. administrator)</entry> + </row> + <row> + <entry><literal>/anonymous</literal></entry> + <entry>remote access as anonymous user</entry> + </row> + <row> + <entry><literal>/debug</literal></entry> + <entry>record protocol telemetry in application's debug log</entry> + </row> + <row> + <entry><literal>/secure</literal></entry> + <entry>do not transmit a plaintext password over the network</entry> + </row> + <row> + <entry><literal>/imap</literal>, <literal>/imap2</literal>, + <literal>/imap2bis</literal>, <literal>/imap4</literal>, + <literal>/imap4rev1</literal></entry> + <entry>equivalent to /service=imap</entry> + </row> + <row> + <entry><literal>/pop3</literal></entry> + <entry>equivalent to /service=pop3</entry> + </row> + <row> + <entry><literal>/nntp</literal></entry> + <entry>equivalent to /service=nntp</entry> + </row> + <row> + <entry><literal>/norsh</literal></entry> + <entry>do not use rsh or ssh to establish a preauthenticated IMAP + session</entry> + </row> + <row> + <entry><literal>/ssl</literal></entry> + <entry>use the Secure Socket Layer to encrypt the session</entry> + </row> + <row> + <entry><literal>/validate-cert</literal></entry> + <entry>validate certificates from TLS/SSL server (this is the default + behavior)</entry> + </row> + <row> + <entry><literal>/novalidate-cert</literal></entry> + <entry>do not validate certificates from TLS/SSL server, needed if + server uses self-signed certificates</entry> + </row> + <row> + <entry><literal>/tls</literal></entry> + <entry>force use of start-TLS to encrypt the session, and reject + connection to servers that do not support it</entry> + </row> + <row> + <entry><literal>/notls</literal></entry> + <entry>do not do start-TLS to encrypt the session, even with servers + that support it</entry> + </row> + <row> + <entry><literal>/readonly</literal></entry> + <entry>request read-only mailbox open (IMAP only; ignored on NNTP, and + an error with SMTP and POP3)</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The user name + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The password associated with the <parameter>username</parameter> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + The <parameter>options</parameter> are a bit mask with one or more of + the following: + <itemizedlist> + <listitem> + <simpara> + <constant>OP_READONLY</constant> - Open mailbox read-only + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_ANONYMOUS</constant> - Don't use or update a + <filename>.newsrc</filename> for news (NNTP only) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but + don't open a mailbox. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close + (see also <function>imap_delete</function> and + <function>imap_expunge</function>) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_DEBUG</constant> - Debug protocol negotiations + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_SHORTCACHE</constant> - Short (elt-only) caching + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_SILENT</constant> - Don't pass up events (internal use) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_PROTOTYPE</constant> - Return driver prototype + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_EXPUNGE</constant> - Silently expunge recycle stream + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_SECURE</constant> - Don't do non-secure authentication + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The <parameter>options</parameter> are a bit mask with one or more of the following: - <itemizedlist> - <listitem> - <simpara> - <constant>OP_READONLY</constant> - Open mailbox read-only - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_ANONYMOUS</constant> - Don't use or update a - <filename>.newsrc</filename> for news (NNTP only) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but - don't open a mailbox. - </simpara> - </listitem> - <listitem> - <simpara> - <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close - (see also <function>imap_delete</function> and - <function>imap_expunge</function>) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_DEBUG</constant> - Debug protocol negotiations - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_SHORTCACHE</constant> - Short (elt-only) caching - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_SILENT</constant> - Don't pass up events (internal use) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_PROTOTYPE</constant> - Return driver prototype - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_EXPUNGE</constant> - Silently expunge recycle stream - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_SECURE</constant> - Don't do non-secure authentication - </simpara> - </listitem> - </itemizedlist> + Returns an IMAP stream on success or &false; on error. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Different use of <function>imap_open</function></title> @@ -236,8 +285,6 @@ ]]> </programlisting> </example> - </para> - <para> <example> <title><function>imap_open</function> example</title> <programlisting role="php"> @@ -274,6 +321,14 @@ </example> </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imap_close</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-ping.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-ping.xml diff -u phpdoc/en/reference/imap/functions/imap-ping.xml:1.7 phpdoc/en/reference/imap/functions/imap-ping.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-ping.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-ping.xml Mon Jan 15 00:05:58 2007 @@ -1,25 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imap-ping"> <refnamediv> <refname>imap_ping</refname> <refpurpose>Check if the IMAP stream is still active</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <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. - </para> - <para> <function>imap_ping</function> pings the stream to see if it's still active. It may discover new mail; this is the preferred method for a periodic "new mail check" as well as a "keep alive" for servers which have inactivity timeout. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the stream is still alive, &false; otherwise. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_ping</function> Example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-qprint.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-qprint.xml diff -u phpdoc/en/reference/imap/functions/imap-qprint.xml:1.5 phpdoc/en/reference/imap/functions/imap-qprint.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-qprint.xml:1.5 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-qprint.xml Mon Jan 15 00:05:58 2007 @@ -1,24 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imap-qprint"> <refnamediv> <refname>imap_qprint</refname> - <refpurpose>Convert a quoted-printable string to an 8 bit - string</refpurpose> + <refpurpose>Convert a quoted-printable string to an 8 bit string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_qprint</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> </methodsynopsis> <para> - Convert a quoted-printable string to an 8 bit string (according - to <ulink url="&url.rfc;2045">RFC2045</ulink>, section - 6.7). + Convert a quoted-printable string to an 8 bit string according to <ulink + url="&url.rfc;2045">RFC2045</ulink>, section 6.7. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + A quoted-printable string + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an 8 bits string. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_8bit</function>. + <simplelist> + <member><function>imap_8bit</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-renamemailbox.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-renamemailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-renamemailbox.xml:1.5 phpdoc/en/reference/imap/functions/imap-renamemailbox.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-renamemailbox.xml:1.5 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-renamemailbox.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imap-renamemailbox"> <refnamediv> <refname>imap_renamemailbox</refname> <refpurpose>Rename an old mailbox to new mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_renamemailbox</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -18,14 +18,46 @@ <function>imap_open</function> for the format of <parameter>mbox</parameter> names). </para> - <para> - &return.success; - </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also <function>imap_createmailbox</function>, - <function>imap_deletemailbox</function>, and - <function>imap_open</function> for the format of - <parameter>mbox</parameter>. + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>old_mbox</parameter></term> + <listitem> + <para> + The old mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>new_mbox</parameter></term> + <listitem> + <para> + The new mailbox name, see <function>imap_open</function> for more + information + </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_createmailbox</function></member> + <member><function>imap_deletemailbox</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-reopen.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-reopen.xml diff -u phpdoc/en/reference/imap/functions/imap-reopen.xml:1.10 phpdoc/en/reference/imap/functions/imap-reopen.xml:1.11 --- phpdoc/en/reference/imap/functions/imap-reopen.xml:1.10 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-reopen.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imap-reopen"> <refnamediv> <refname>imap_reopen</refname> <refpurpose>Reopen IMAP stream to new mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_reopen</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -14,44 +14,74 @@ <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function reopens the specified stream to a new - <parameter>mailbox</parameter> on an IMAP or NNTP server. + Reopens the specified stream to a new <parameter>mailbox</parameter> on an + IMAP or NNTP server. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The <parameter>options</parameter> are a bit mask with one or more of the following: - <itemizedlist> - <listitem> - <simpara> - <constant>OP_READONLY</constant> - Open mailbox read-only - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_ANONYMOUS</constant> - Don't use or update a - <filename>.newsrc</filename> for news (NNTP only) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but - don't open a mailbox. - </simpara> - </listitem> - <listitem> - <simpara> - <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close - (see also <function>imap_delete</function> and - <function>imap_expunge</function>) - </simpara> - </listitem> - </itemizedlist> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + The <parameter>options</parameter> are a bit mask with one or more of + the following: + <itemizedlist> + <listitem> + <simpara> + <constant>OP_READONLY</constant> - Open mailbox read-only + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_ANONYMOUS</constant> - Don't use or update a + <filename>.newsrc</filename> for news (NNTP only) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but + don't open a mailbox. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close + (see also <function>imap_delete</function> and + <function>imap_expunge</function>) + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> - <example> - <title><function>imap_reopen</function> example</title> - <programlisting role="php"> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>imap_reopen</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org:143}INBOX", "username", "password") or die(implode(", ", imap_errors())); @@ -60,10 +90,10 @@ // .. ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> - </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml diff -u phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml:1.9 phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml:1.9 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml Mon Jan 15 00:05:58 2007 @@ -1,22 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imap-rfc822-parse-adrlist"> <refnamediv> <refname>imap_rfc822_parse_adrlist</refname> <refpurpose>Parses an address string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_rfc822_parse_adrlist</methodname> <methodparam><type>string</type><parameter>address</parameter></methodparam> <methodparam><type>string</type><parameter>default_host</parameter></methodparam> </methodsynopsis> <para> - This function parses the address string as defined in - <ulink url="&url.rfc;2822">RFC2822</ulink> and - for each address, returns an array of objects. - The objects properties are: + Parses the address string as defined in <ulink + url="&url.rfc;2822">RFC2822</ulink> and for each address. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>address</parameter></term> + <listitem> + <para> + A string containing addresses + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>default_host</parameter></term> + <listitem> + <para> + The default host name + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of objects. The objects properties are: </para> <para> <itemizedlist> @@ -42,6 +69,9 @@ </listitem> </itemizedlist> </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_rfc822_parse_adrlist</function> example</title> @@ -55,18 +85,48 @@ die("something is wrong\n"); } -foreach ($address_array as $val) { - echo "mailbox : " . $val->mailbox . "<br />\n"; - echo "host : " . $val->host . "<br />\n"; - echo "personal: " . $val->personal . "<br />\n"; - echo "adl : " . $val->adl . "<br />\n"; +foreach ($address_array as $id => $val) { + echo "# $id\n"; + echo " mailbox : " . $val->mailbox . "\n"; + echo " host : " . $val->host . "\n"; + echo " personal: " . $val->personal . "\n"; + echo " adl : " . $val->adl . "\n"; } ?> ]]> </programlisting> + &example.outputs; + <screen> +<![CDATA[ +# 0 + mailbox : doe + host : example.com + personal: Joe Doe + adl : +# 1 + mailbox : postmaster + host : example.com + personal: + adl : +# 2 + mailbox : root + host : example.com + personal: + adl : + +]]> + </screen> </example> </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imap_rfc822_parse_headers</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-rfc822-parse-headers.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml diff -u phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml:1.3 phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml:1.3 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml Mon Jan 15 00:05:58 2007 @@ -1,21 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.imap-rfc822-parse-headers"> <refnamediv> <refname>imap_rfc822_parse_headers</refname> <refpurpose>Parse mail headers from a string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>imap_rfc822_parse_headers</methodname> <methodparam><type>string</type><parameter>headers</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam> </methodsynopsis> <para> - This function returns an object of various header elements, - similar to <function>imap_header</function>, except without the - flags and other elements that come from the IMAP server. + Gets an object of various header elements, similar to + <function>imap_header</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>headers</parameter></term> + <listitem> + <para> + The parsed headers data + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>defaulthost</parameter></term> + <listitem> + <para> + The default host name + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object similar to the one returned by + <function>imap_header</function>, except for the flags and other + properties that come from the IMAP server. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imap_rfc822_parse_adrlist</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml diff -u phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml:1.9 phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml:1.9 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imap-rfc822-write-address"> <refnamediv> <refname>imap_rfc822_write_address</refname> <refpurpose>Returns a properly formatted email address given the mailbox, host, and personal info</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_rfc822_write_address</methodname> <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> @@ -14,21 +14,67 @@ <methodparam><type>string</type><parameter>personal</parameter></methodparam> </methodsynopsis> <para> - Returns a properly formatted email address as defined in - <ulink url="&url.rfc;2822">RFC2822</ulink> - given the <parameter>mailbox</parameter>, <parameter>host</parameter>, - and <parameter>personal</parameter> info. + Returns a properly formatted email address as defined in <ulink + url="&url.rfc;2822">RFC2822</ulink> given the needed information. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>host</parameter></term> + <listitem> + <para> + The email host part + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>personal</parameter></term> + <listitem> + <para> + The name of the account owner + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string properly formatted email address as defined in <ulink + url="&url.rfc;2822">RFC2822</ulink>. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_rfc822_write_address</function> example</title> <programlisting role="php"> <![CDATA[ <?php -echo imap_rfc822_write_address("hartmut", "cvs.php.net", "Hartmut Holzgraefe") . "\n"; +echo imap_rfc822_write_address("hartmut", "example.com", "Hartmut Holzgraefe"); ?> ]]> </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Hartmut Holzgraefe <hartmut@example.com> +]]> + </screen> </example> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-search.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-search.xml diff -u phpdoc/en/reference/imap/functions/imap-search.xml:1.8 phpdoc/en/reference/imap/functions/imap-search.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-search.xml:1.8 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-search.xml Mon Jan 15 00:05:58 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imap-search"> <refnamediv> <refname>imap_search</refname> <refpurpose>This function returns an array of messages matching the given search criteria</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_search</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -16,148 +16,207 @@ </methodsynopsis> <para> This function performs a search on the mailbox currently opened - in the given imap stream. <parameter>criteria</parameter> is a - string, delimited by spaces, in which the following keywords are - allowed. Any multi-word arguments (e.g. FROM "joey smith") must be - quoted. - <itemizedlist> - <listitem> - <simpara> - ALL - return all messages matching the rest of the criteria - </simpara> - </listitem> - <listitem> - <simpara> - ANSWERED - match messages with the \\ANSWERED flag set - </simpara> - </listitem> - <listitem> - <simpara> - BCC "string" - match messages with "string" in the Bcc: field - </simpara> - </listitem> - <listitem> - <simpara> - BEFORE "date" - match messages with Date: before "date" - </simpara> - </listitem> - <listitem> - <simpara> - BODY "string" - match messages with "string" in the body of the message - </simpara> - </listitem> - <listitem> - <simpara> - CC "string" - match messages with "string" in the Cc: field - </simpara> - </listitem> - <listitem> - <simpara> - DELETED - match deleted messages - </simpara> - </listitem> - <listitem> - <simpara> - FLAGGED - match messages with the \\FLAGGED (sometimes - referred to as Important or Urgent) flag set - </simpara> - </listitem> - <listitem> - <simpara> - FROM "string" - match messages with "string" in the From: field - </simpara> - </listitem> - <listitem> - <simpara> - KEYWORD "string" - match messages with "string" as a keyword - </simpara> - </listitem> - <listitem> - <simpara> - NEW - match new messages - </simpara> - </listitem> - <listitem> - <simpara> - OLD - match old messages - </simpara> - </listitem> - <listitem> - <simpara> - ON "date" - match messages with Date: matching "date" - </simpara> - </listitem> - <listitem> - <simpara> - RECENT - match messages with the \\RECENT flag set - </simpara> - </listitem> - <listitem> - <simpara> - SEEN - match messages that have been read (the \\SEEN flag is set) - </simpara> - </listitem> - <listitem> - <simpara> - SINCE "date" - match messages with Date: after "date" - </simpara> - </listitem> - <listitem> - <simpara> - SUBJECT "string" - match messages with "string" in the Subject: - </simpara> - </listitem> - <listitem> - <simpara> - TEXT "string" - match messages with text "string" - </simpara> - </listitem> - <listitem> - <simpara> - TO "string" - match messages with "string" in the To: - </simpara> - </listitem> - <listitem> - <simpara> - UNANSWERED - match messages that have not been answered - </simpara> - </listitem> - <listitem> - <simpara> - UNDELETED - match messages that are not deleted - </simpara> - </listitem> - <listitem> - <simpara> - UNFLAGGED - match messages that are not flagged - </simpara> - </listitem> - <listitem> - <simpara> - UNKEYWORD "string" - match messages that do not have the - keyword "string" - </simpara> - </listitem> - <listitem> - <simpara> - UNSEEN - match messages which have not been read yet - </simpara> - </listitem> - </itemizedlist> + in the given imap stream. </para> <para> For example, to match all unanswered messages sent by Mom, you'd use: "UNANSWERED FROM mom". Searches appear to be case insensitive. This list of criteria is from a reading of the UW c-client source code and may be incomplete or - inaccurate (see also <ulink url="&url.rfc;2060">RFC2060</ulink>, section 6.4.4). + inaccurate (see also <ulink url="&url.rfc;2060">RFC2060</ulink>, + section 6.4.4). </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>criteria</parameter></term> + <listitem> + <para> + A string, delimited by spaces, in which the following keywords are + allowed. Any multi-word arguments (e.g. FROM "joey smith") must be + quoted. + <itemizedlist> + <listitem> + <simpara> + ALL - return all messages matching the rest of the criteria + </simpara> + </listitem> + <listitem> + <simpara> + ANSWERED - match messages with the \\ANSWERED flag set + </simpara> + </listitem> + <listitem> + <simpara> + BCC "string" - match messages with "string" in the Bcc: field + </simpara> + </listitem> + <listitem> + <simpara> + BEFORE "date" - match messages with Date: before "date" + </simpara> + </listitem> + <listitem> + <simpara> + BODY "string" - match messages with "string" in the body of the message + </simpara> + </listitem> + <listitem> + <simpara> + CC "string" - match messages with "string" in the Cc: field + </simpara> + </listitem> + <listitem> + <simpara> + DELETED - match deleted messages + </simpara> + </listitem> + <listitem> + <simpara> + FLAGGED - match messages with the \\FLAGGED (sometimes + referred to as Important or Urgent) flag set + </simpara> + </listitem> + <listitem> + <simpara> + FROM "string" - match messages with "string" in the From: field + </simpara> + </listitem> + <listitem> + <simpara> + KEYWORD "string" - match messages with "string" as a keyword + </simpara> + </listitem> + <listitem> + <simpara> + NEW - match new messages + </simpara> + </listitem> + <listitem> + <simpara> + OLD - match old messages + </simpara> + </listitem> + <listitem> + <simpara> + ON "date" - match messages with Date: matching "date" + </simpara> + </listitem> + <listitem> + <simpara> + RECENT - match messages with the \\RECENT flag set + </simpara> + </listitem> + <listitem> + <simpara> + SEEN - match messages that have been read (the \\SEEN flag is set) + </simpara> + </listitem> + <listitem> + <simpara> + SINCE "date" - match messages with Date: after "date" + </simpara> + </listitem> + <listitem> + <simpara> + SUBJECT "string" - match messages with "string" in the Subject: + </simpara> + </listitem> + <listitem> + <simpara> + TEXT "string" - match messages with text "string" + </simpara> + </listitem> + <listitem> + <simpara> + TO "string" - match messages with "string" in the To: + </simpara> + </listitem> + <listitem> + <simpara> + UNANSWERED - match messages that have not been answered + </simpara> + </listitem> + <listitem> + <simpara> + UNDELETED - match messages that are not deleted + </simpara> + </listitem> + <listitem> + <simpara> + UNFLAGGED - match messages that are not flagged + </simpara> + </listitem> + <listitem> + <simpara> + UNKEYWORD "string" - match messages that do not have the + keyword "string" + </simpara> + </listitem> + <listitem> + <simpara> + UNSEEN - match messages which have not been read yet + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + Valid values for <parameter>options</parameter> are + <constant>SE_UID</constant>, which causes the returned array to + contain UIDs instead of messages sequence numbers. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>charset</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Valid values for flags are SE_UID, which causes the returned - array to contain UIDs instead of messages sequence numbers. + Returns an array of message numbers or UIDs. </para> <para> - Parameter <parameter>charset</parameter> was added in PHP 4.3.3. + Return &false; if it does not understand the search + <parameter>criteria</parameter> or no messages have been found. + </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.3</entry> + <entry> + The <parameter>charset</parameter> parameter was added + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-set-quota.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-set-quota.xml diff -u phpdoc/en/reference/imap/functions/imap-set-quota.xml:1.9 phpdoc/en/reference/imap/functions/imap-set-quota.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-set-quota.xml:1.9 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-set-quota.xml Mon Jan 15 00:05:59 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imap-set-quota"> <refnamediv> <refname>imap_set_quota</refname> <refpurpose>Sets a quota for a given mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_set_quota</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -14,27 +14,42 @@ <methodparam><type>int</type><parameter>quota_limit</parameter></methodparam> </methodsynopsis> <para> - Sets an upper limit quota on a per mailbox basis. This function - requires the <parameter>imap_stream</parameter> to have been opened - as the mail administrator account. It will not work if opened as - any other user. - </para> - <para> - This function is currently only available to users of the c-client2000 - or greater library. + Sets an upper limit quota on a per mailbox basis. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>imap_stream</parameter> is the stream pointer returned from - a <function>imap_open</function> call. This stream must be opened as - the mail administrator, other wise this function will fail. - <parameter>quota_root</parameter> is the mailbox to have a quota set. This - should follow the IMAP standard format for a mailbox, 'user.name'. - <parameter>quota_limit</parameter> is the maximum size (in KB) for - the <parameter>quota_root</parameter>. + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>quota_root</parameter></term> + <listitem> + <para> + The mailbox to have a quota set. This should follow the IMAP standard + format for a mailbox: <literal>user.name</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>quota_limit</parameter></term> + <listitem> + <para> + The maximum size (in KB) for the <parameter>quota_root</parameter> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Returns &true; on success and &false; on error. + &return.success; </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_set_quota</function> example</title> @@ -54,9 +69,25 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <para> + This function is currently only available to users of the c-client2000 + or greater library. + </para> + <para> + The given <parameter>imap_stream</parameter> must be opened as the mail + administrator, other wise this function will fail. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_open</function> and - <function>imap_get_quota</function>. + <simplelist> + <member><function>imap_open</function></member> + <member><function>imap_get_quota</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-setacl.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-setacl.xml diff -u phpdoc/en/reference/imap/functions/imap-setacl.xml:1.6 phpdoc/en/reference/imap/functions/imap-setacl.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-setacl.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-setacl.xml Mon Jan 15 00:05:59 2007 @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id='function.imap-setacl'> <refnamediv> <refname>imap_setacl</refname> <refpurpose>Sets the ACL for a giving mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_setacl</methodname> - <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</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> @@ -17,12 +17,57 @@ <para> &warn.undocumented.func; </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rights</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This function is currently only available to users of the c-client2000 - or greater library. + &return.success; </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <para> + This function is currently only available to users of the c-client2000 or + greater library. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_getacl</function>. + <simplelist> + <member><function>imap_getacl</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-setflag-full.xml?r1=1.12&r2=1.13&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-setflag-full.xml diff -u phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.12 phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.13 --- phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.12 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-setflag-full.xml Mon Jan 15 00:05:59 2007 @@ -1,41 +1,78 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <refentry id="function.imap-setflag-full"> <refnamediv> <refname>imap_setflag_full</refname> <refpurpose>Sets flags on messages</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_setflag_full</methodname> - <methodparam><type>resource</type><parameter>stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>sequence</parameter></methodparam> <methodparam><type>string</type><parameter>flag</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function causes a store to add the specified - <parameter>flag</parameter> to the flags set for the messages - in the specified <parameter>sequence</parameter>. + Causes a store to add the specified <parameter>flag</parameter> to the + flags set for the messages in the specified + <parameter>sequence</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The flags which you can set are "\\Seen", "\\Answered", - "\\Flagged", "\\Deleted", and "\\Draft" (as defined - by <ulink url="&url.rfc;2060">RFC2060</ulink>). + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>sequence</parameter></term> + <listitem> + <para> + A sequence of message numbers. You can enumerate desired messages + with the <literal>X,Y</literal> syntax, or retrieve all messages + within an interval with the <literal>X:Y</literal> syntax + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flag</parameter></term> + <listitem> + <para> + The flags which you can set are <literal>\\Seen</literal>, + <literal>\\Answered</literal>, <literal>\\Flagged</literal>, + <literal>\\Deleted</literal>, and <literal>\\Draft</literal> as + defined by <ulink url="&url.rfc;2060">RFC2060</ulink>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + A bit mask that may contain the single option: + <itemizedlist> + <listitem> + <simpara> + <constant>ST_UID</constant> - The sequence argument contains UIDs + instead of sequence numbers + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>options</parameter> are a bit mask and may contain - the single option: - <itemizedlist> - <listitem> - <simpara> - <constant>ST_UID</constant> - The sequence argument contains UIDs - instead of sequence numbers - </simpara> - </listitem> - </itemizedlist> + &return.success; </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_setflag_full</function> example</title> @@ -56,8 +93,13 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_clearflag_full</function>. + <simplelist> + <member><function>imap_clearflag_full</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-sort.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-sort.xml diff -u phpdoc/en/reference/imap/functions/imap-sort.xml:1.6 phpdoc/en/reference/imap/functions/imap-sort.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-sort.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-sort.xml Mon Jan 15 00:05:59 2007 @@ -1,15 +1,15 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imap-sort"> <refnamediv> <refname>imap_sort</refname> - <refpurpose>Sort an array of message headers</refpurpose> + <refpurpose>Gets and sort messages</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_sort</methodname> - <methodparam><type>resource</type><parameter>stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>int</type><parameter>criteria</parameter></methodparam> <methodparam><type>int</type><parameter>reverse</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> @@ -17,69 +17,133 @@ <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> </methodsynopsis> <para> - Returns an array of message numbers sorted by the given - parameters. - </para> - <para> - <parameter>Reverse</parameter> is 1 for reverse-sorting. + Gets and sorts message numbers by the given parameters. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Criteria can be one (and only one) of the following: - <itemizedlist> - <listitem> - <simpara> - <constant>SORTDATE</constant> - message Date - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTARRIVAL</constant> - arrival date - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTFROM</constant> - mailbox in first From address - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTSUBJECT</constant> - message subject - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTTO</constant> - mailbox in first To address - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTCC</constant> - mailbox in first cc address - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTSIZE</constant> - size of message in octets - </simpara> - </listitem> - </itemizedlist> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>criteria</parameter></term> + <listitem> + <para> + Criteria can be one (and only one) of the following: + <itemizedlist> + <listitem> + <simpara> + <constant>SORTDATE</constant> - message Date + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTARRIVAL</constant> - arrival date + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTFROM</constant> - mailbox in first From address + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTSUBJECT</constant> - message subject + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTTO</constant> - mailbox in first To address + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTCC</constant> - mailbox in first cc address + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTSIZE</constant> - size of message in octets + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>reverse</parameter></term> + <listitem> + <para> + Set this to 1 for reverse sorting + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + The <parameter>options</parameter> are a bitmask of one or more of the + following: + <itemizedlist> + <listitem> + <simpara> + <constant>SE_UID</constant> - Return UIDs instead of sequence numbers + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SE_NOPREFETCH</constant> - Don't prefetch searched messages + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>search_criteria</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>charset</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The flags are a bitmask of one or more of the following: - <itemizedlist> - <listitem> - <simpara> - <constant>SE_UID</constant> - Return UIDs instead of sequence numbers - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SE_NOPREFETCH</constant> - Don't prefetch searched messages - </simpara> - </listitem> - </itemizedlist> + Returns an array of message numbers sorted by the given + parameters. </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; <para> - Parameter <parameter>charset</parameter> was added in PHP 4.3.3. + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.3</entry> + <entry> + The <parameter>charset</parameter> parameter was added + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-status.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-status.xml diff -u phpdoc/en/reference/imap/functions/imap-status.xml:1.10 phpdoc/en/reference/imap/functions/imap-status.xml:1.11 --- phpdoc/en/reference/imap/functions/imap-status.xml:1.10 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-status.xml Mon Jan 15 00:05:59 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imap-status"> <refnamediv> <refname>imap_status</refname> - <refpurpose>This function returns status information on a mailbox other than the current one</refpurpose> + <refpurpose>Returns status information on a mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>imap_status</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -14,57 +14,94 @@ <methodparam><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function returns an object containing status - information. Valid flags are: - <itemizedlist> - <listitem> - <simpara> - SA_MESSAGES - set status->messages to the number of messages - in the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - SA_RECENT - set status->recent to the number of recent - messages in the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - SA_UNSEEN - set status->unseen to the number of unseen (new) - messages in the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - SA_UIDNEXT - set status->uidnext to the next uid to be used in - the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - SA_UIDVALIDITY - set status->uidvalidity to a constant that - changes when uids for the mailbox may no longer be valid - </simpara> - </listitem> - <listitem> - <simpara> - SA_ALL - set all of the above - </simpara> - </listitem> - </itemizedlist> + Gets status information about the given <parameter>mailbox</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + Valid flags are: + <itemizedlist> + <listitem> + <simpara> + <constant>SA_MESSAGES</constant> - set status->messages to the + number of messages in the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SA_RECENT</constant> - set status->recent to the number + of recent messages in the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SA_UNSEEN</constant> - set status->unseen to the number + of unseen (new) messages in the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SA_UIDNEXT</constant> - set status->uidnext to the next + uid to be used in the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SA_UIDVALIDITY</constant> - set status->uidvalidity to a + constant that changes when uids for the mailbox may no longer be + valid + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SA_ALL</constant> - set all of the above + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - status->flags is also set, which contains a bitmask which can be - checked against any of the above constants. + This function returns an object containing status information. + The object has the following properties: <literal>messages</literal>, + <literal>recent</literal>, <literal>unseen</literal>, + <literal>uidnext</literal>, and <literal>uidvalidity</literal>. </para> <para> + <literal>flags</literal> is also set, which contains a bitmask which can + be checked against any of the above constants. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title><function>imap_status</function> example</title> <programlisting role="php"> <![CDATA[ <?php -$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN) +$mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN) or die("can't connect: " . imap_last_error()); $status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL); http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-subscribe.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-subscribe.xml diff -u phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.6 phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-subscribe.xml Mon Jan 15 00:05:59 2007 @@ -1,25 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imap-subscribe"> <refnamediv> <refname>imap_subscribe</refname> <refpurpose>Subscribe to a mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_subscribe</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> </methodsynopsis> <para> Subscribe to a new mailbox. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_unsubscribe</function>. + <simplelist> + <member><function>imap_unsubscribe</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-thread.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-thread.xml diff -u phpdoc/en/reference/imap/functions/imap-thread.xml:1.7 phpdoc/en/reference/imap/functions/imap-thread.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-thread.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-thread.xml Mon Jan 15 00:05:59 2007 @@ -1,18 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id='function.imap-thread'> <refnamediv> <refname>imap_thread</refname> <refpurpose>Returns a tree of threaded message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imap_thread</methodname> - <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> + Gets a tree of a threaded message. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> <function>imap_thread</function> returns an associative array containing a tree of messages threaded by <literal>REFERENCES</literal>, or &false; on error. @@ -32,6 +53,9 @@ </para></listitem> </itemizedlist> </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imap_thread</function> Example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-timeout.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-timeout.xml diff -u phpdoc/en/reference/imap/functions/imap-timeout.xml:1.2 phpdoc/en/reference/imap/functions/imap-timeout.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-timeout.xml:1.2 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-timeout.xml Mon Jan 15 00:05:59 2007 @@ -1,20 +1,18 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.imap-timeout"> <refnamediv> <refname>imap_timeout</refname> <refpurpose>Set or fetch imap timeout</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>imap_timeout</methodname> <methodparam><type>int</type><parameter>timeout_type</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-uid.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-uid.xml diff -u phpdoc/en/reference/imap/functions/imap-uid.xml:1.6 phpdoc/en/reference/imap/functions/imap-uid.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-uid.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-uid.xml Mon Jan 15 00:05:59 2007 @@ -1,31 +1,63 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imap-uid"> <refnamediv> <refname>imap_uid</refname> <refpurpose>This function returns the UID for the given message sequence number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imap_uid</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>msgno</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> </methodsynopsis> <para> This function returns the UID for the given message sequence number. An UID is a unique identifier that will not change over time while a message sequence number may change whenever the - content of the mailbox changes. This function is the inverse of - <function>imap_msgno</function>. + content of the mailbox changes. </para> + <para> + This function is the inverse of <function>imap_msgno</function>. + </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> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The UID of the given message. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <note> <para> - This is not supported by POP3 mailboxes. + This function is not supported by POP3 mailboxes. </para> </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_msgno</function>. + <simplelist> + <member><function>imap_msgno</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-undelete.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-undelete.xml diff -u phpdoc/en/reference/imap/functions/imap-undelete.xml:1.7 phpdoc/en/reference/imap/functions/imap-undelete.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-undelete.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-undelete.xml Mon Jan 15 00:05:59 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imap-undelete"> <refnamediv> <refname>imap_undelete</refname> <refpurpose>Unmark the message which is marked deleted</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_undelete</methodname> <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> @@ -14,17 +14,46 @@ <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> - This function removes the deletion flag for a specified message, - which is set by <function>imap_delete</function> or - <function>imap_mail_move</function>. + Removes the deletion flag for a specified message, which is set by + <function>imap_delete</function> or <function>imap_mail_move</function>. </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>flags</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: - <function>imap_delete</function>, and - <function>imap_mail_move</function>. + <simplelist> + <member><function>imap_delete</function></member> + <member><function>imap_mail_move</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-unsubscribe.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-unsubscribe.xml diff -u phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.6 phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.6 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-unsubscribe.xml Mon Jan 15 00:05:59 2007 @@ -1,25 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imap-unsubscribe"> <refnamediv> <refname>imap_unsubscribe</refname> <refpurpose>Unsubscribe from a mailbox</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imap_unsubscribe</methodname> <methodparam><type>string</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> </methodsynopsis> <para> - Unsubscribe from a specified mailbox. + Unsubscribe from the specified <parameter>mailbox</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &imap.imap-stream.description; + <varlistentry> + <term><parameter>mailbox</parameter></term> + <listitem> + <para> + The mailbox name, see <function>imap_open</function> for more + information + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_subscribe</function>. + <simplelist> + <member><function>imap_subscribe</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-utf7-decode.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-utf7-decode.xml diff -u phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.8 phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.8 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-utf7-decode.xml Mon Jan 15 00:05:59 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imap-utf7-decode"> <refnamediv> <refname>imap_utf7_decode</refname> <refpurpose>Decodes a modified UTF-7 encoded string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_utf7_decode</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> @@ -15,24 +15,43 @@ Decodes modified UTF-7 <parameter>text</parameter> into ISO-8859-1 string. </para> <para> + This function is needed to decode mailbox names that contain certain + characters which are not in range of printable ASCII characters. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + A modified UTF-7 encoding string, as defined in <ulink + url="&url.rfc;2060">RFC 2060</ulink>, section 5.1.3 (original UTF-7 + was defined in <ulink url="&url.rfc;1642">RFC1642</ulink>). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns a string that is encoded in ISO-8859-1 and consists of the same sequence of characters in <parameter>text</parameter>, or &false; if <parameter>text</parameter> contains invalid modified UTF-7 sequence or <parameter>text</parameter> contains a character that is not part of ISO-8859-1 character set. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - This function is needed to decode mailbox names that contain certain - characters which are not in range of printable ASCII characters. - </para> - <para> - The modified UTF-7 encoding is defined in - <ulink url="&url.rfc;2060">RFC 2060</ulink>, section - 5.1.3 (original UTF-7 was defined in <ulink - url="&url.rfc;1642">RFC1642</ulink>). - </para> - <para> - See also: <function>imap_utf7_encode</function>. + <simplelist> + <member><function>imap_utf7_encode</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-utf7-encode.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-utf7-encode.xml diff -u phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.9 phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.9 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-utf7-encode.xml Mon Jan 15 00:05:59 2007 @@ -1,33 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imap-utf7-encode"> <refnamediv> <refname>imap_utf7_encode</refname> <refpurpose>Converts ISO-8859-1 string to modified UTF-7 text</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_utf7_encode</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> </methodsynopsis> <para> - Converts <parameter>data</parameter> to modified UTF-7 - text. Note that <parameter>data</parameter> is expected to be - encoded in ISO-8859-1. + Converts <parameter>data</parameter> to modified UTF-7 text. </para> <para> - This is needed to encode mailbox names that contain certain - characters which are not in range of printable ASCII characters. + This is needed to encode mailbox names that contain certain characters + which are not in range of printable ASCII characters. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The modified UTF-7 encoding is defined in <ulink - url="&url.rfc;2060">RFC 2060</ulink>, section 5.1.3 - (original UTF-7 was defined in <ulink + <variablelist> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + An ISO-8859-1 string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns <parameter>data</parameter> encoded with the modified UTF-7 + encoding as defined in <ulink url="&url.rfc;2060">RFC 2060</ulink>, + section 5.1.3 (original UTF-7 was defined in <ulink url="&url.rfc;1642">RFC1642</ulink>). </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>imap_utf7_decode</function>. + <simplelist> + <member><function>imap_utf7_decode</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-utf8.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-utf8.xml diff -u phpdoc/en/reference/imap/functions/imap-utf8.xml:1.7 phpdoc/en/reference/imap/functions/imap-utf8.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-utf8.xml:1.7 Sun Jan 14 15:37:21 2007 +++ phpdoc/en/reference/imap/functions/imap-utf8.xml Mon Jan 15 00:05:59 2007 @@ -1,24 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imap-utf8"> <refnamediv> <refname>imap_utf8</refname> <refpurpose>Converts MIME-encoded text to UTF-8</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>imap_utf8</methodname> <methodparam><type>string</type><parameter>mime_encoded_text</parameter></methodparam> </methodsynopsis> <para> Converts the given <parameter>mime_encoded_text</parameter> to - UTF-8. MIME encoding method and the UTF-8 specification are described in - <ulink url="&url.rfc;2047">RFC2047</ulink> and - <ulink url="&url.rfc;2044">RFC2044</ulink> respectively. + UTF-8. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>mime_encoded_text</parameter></term> + <listitem> + <para> + A MIME encoded string. MIME encoding method and the UTF-8 + specification are described in <ulink + url="&url.rfc;2047">RFC2047</ulink> and <ulink + url="&url.rfc;2044">RFC2044</ulink> respectively. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an UTF-8 encoded string. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imap_mime_header_decode</function>. + <simplelist> + <member><function>imap_mime_header_decode</function></member> + </simplelist> </para> </refsect1> </refentry>