cvs: phpdoc /en/reference/imap constants.xml /en/reference/imap/functions imap-append.xml imap-body.xml imap-clearflag-full.xml imap-close.xml
imap-createmailbox.xml imap-delete.xml imap-deletemailbox.xml imap-errors.xml imap-fetchbody.xml imap-fetchheader.xml imap-getacl.xml
imap-getmailboxes.xml imap-last-error.xml imap-list.xml imap-listscan.xml imap-mail-compose.xml imap-mail-copy.xml imap-mail-move.xml imap-mail.xml
imap-mime-header-decode.xml imap-msgno.xml imap-open.xml imap-qprint.xml imap-reopen.xml imap-rfc822-parse-adrlist.xml imap-rfc822-write-address.xml
imap-setacl.xml imap-setflag-full.xml imap-sort.xml imap-status.xml imap-subscribe.xml imap-uid.xml imap-undelete.xml imap-unsubscribe.xml
imap-utf7-decode.xml imap-utf7-encode.xml
| From: | Mehdi Achour | Date: | Mon, 08 Mar 2004 09:18:47 +0000 |
| Subject: | cvs: phpdoc /en/reference/imap constants.xml /en/reference/imap/functions imap-append.xml imap-body.xml imap-clearflag-full.xml imap-close.xml imap-createmailbox.xml imap-delete.xml imap-deletemailbox.xml imap-errors.xml imap-fetchbody.xml imap-fetchheader.xml imap-getacl.xml imap-getmailboxes.xml imap-last-error.xml imap-list.xml imap-listscan.xml imap-mail-compose.xml imap-mail-copy.xml imap-mail-move.xml imap-mail.xml imap-mime-header-decode.xml imap-msgno.xml imap-open.xml imap-qprint.xml imap-reopen.xml imap-rfc822-parse-adrlist.xml imap-rfc822-write-address.xml imap-setacl.xml imap-setflag-full.xml imap-sort.xml imap-status.xml imap-subscribe.xml imap-uid.xml imap-undelete.xml imap-unsubscribe.xml imap-utf7-decode.xml imap-utf7-encode.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969359408@lists.php.net to get a copy of this message | ||
didou Mon Mar 8 04:18:47 2004 EDT
Modified files:
/phpdoc/en/reference/imap constants.xml
/phpdoc/en/reference/imap/functions imap-append.xml imap-body.xml
imap-clearflag-full.xml
imap-close.xml
imap-createmailbox.xml
imap-delete.xml
imap-deletemailbox.xml
imap-errors.xml
imap-fetchbody.xml
imap-fetchheader.xml
imap-getacl.xml
imap-getmailboxes.xml
imap-last-error.xml
imap-list.xml imap-listscan.xml
imap-mail-compose.xml
imap-mail-copy.xml
imap-mail-move.xml
imap-mail.xml
imap-mime-header-decode.xml
imap-msgno.xml imap-open.xml
imap-qprint.xml imap-reopen.xml
imap-rfc822-parse-adrlist.xml
imap-rfc822-write-address.xml
imap-setacl.xml
imap-setflag-full.xml
imap-sort.xml imap-status.xml
imap-subscribe.xml imap-uid.xml
imap-undelete.xml
imap-unsubscribe.xml
imap-utf7-decode.xml
imap-utf7-encode.xml
Log:
Fill in the blanks in constants.xml
CS
Replaced <programlisting> ... with <listitem>
Added constant/parameter tags
Added See Also parts
Used &return.success;
Added some para to make the whole thing more easy to read
Removed redundancy
http://cvs.php.net/diff.php/phpdoc/en/reference/imap/constants.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/imap/constants.xml diff -u phpdoc/en/reference/imap/constants.xml:1.2 phpdoc/en/reference/imap/constants.xml:1.3 --- phpdoc/en/reference/imap/constants.xml:1.2 Wed May 28 19:03:08 2003 +++ phpdoc/en/reference/imap/constants.xml Mon Mar 8 04:18:35 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <section id="imap.constants"> &reftitle.constants; &extension.constants; @@ -33,7 +33,7 @@ </term> <listitem> <simpara> - + Open mailbox read-only </simpara> </listitem> </varlistentry> @@ -44,7 +44,8 @@ </term> <listitem> <simpara> - + Don't use or update a <filename>.newsrc</filename> for news + (NNTP only) </simpara> </listitem> </varlistentry> @@ -88,7 +89,7 @@ </term> <listitem> <simpara> - + For IMAP and NNTP names, open a connection but don't open a mailbox. </simpara> </listitem> </varlistentry> @@ -121,7 +122,8 @@ </term> <listitem> <simpara> - + silently expunge the mailbox before closing when + calling <function>imap_close</function> </simpara> </listitem> </varlistentry> @@ -132,7 +134,7 @@ </term> <listitem> <simpara> - + The parameter is a UID </simpara> </listitem> </varlistentry> @@ -143,7 +145,7 @@ </term> <listitem> <simpara> - + Do not set the \Seen flag if not already set </simpara> </listitem> </varlistentry> @@ -165,7 +167,7 @@ </term> <listitem> <simpara> - + The return string is in internal format, will not canonicalize to CRLF. </simpara> </listitem> </varlistentry> @@ -187,7 +189,7 @@ </term> <listitem> <simpara> - + The sequence argument contains UIDs instead of sequence numbers </simpara> </listitem> </varlistentry> @@ -220,7 +222,7 @@ </term> <listitem> <simpara> - + the sequence numbers contain UIDS </simpara> </listitem> </varlistentry> @@ -231,7 +233,8 @@ </term> <listitem> <simpara> - + Delete the messages from the current mailbox after copying + with <function>imap_mail_copy</function> </simpara> </listitem> </varlistentry> @@ -242,7 +245,7 @@ </term> <listitem> <simpara> - + Return UIDs instead of sequence numbers </simpara> </listitem> </varlistentry> @@ -264,7 +267,7 @@ </term> <listitem> <simpara> - + Don't prefetch searched messages </simpara> </listitem> </varlistentry> @@ -363,7 +366,8 @@ </term> <listitem> <simpara> - + This mailbox has no "children" (there are no + mailboxes below this one). </simpara> </listitem> </varlistentry> @@ -374,7 +378,8 @@ </term> <listitem> <simpara> - + This is only a container, not a mailbox - you + cannot open it. </simpara> </listitem> </varlistentry> @@ -385,7 +390,7 @@ </term> <listitem> <simpara> - + This mailbox is marked. Only used by UW-IMAPD. </simpara> </listitem> </varlistentry> @@ -396,7 +401,8 @@ </term> <listitem> <simpara> - + This mailbox is not marked. Only used by + UW-IMAPD. </simpara> </listitem> </varlistentry> @@ -407,7 +413,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + message Date </simpara> </listitem> </varlistentry> @@ -418,7 +425,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + arrival date </simpara> </listitem> </varlistentry> @@ -429,7 +437,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + mailbox in first From address </simpara> </listitem> </varlistentry> @@ -440,7 +449,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + message subject </simpara> </listitem> </varlistentry> @@ -451,7 +461,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + mailbox in first To address </simpara> </listitem> </varlistentry> @@ -462,7 +473,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + mailbox in first cc address </simpara> </listitem> </varlistentry> @@ -473,7 +485,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + size of message in octets </simpara> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-append.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/imap/functions/imap-append.xml diff -u phpdoc/en/reference/imap/functions/imap-append.xml:1.8 phpdoc/en/reference/imap/functions/imap-append.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-append.xml:1.8 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-append.xml Mon Mar 8 04:18:40 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-append"> <refnamediv> @@ -40,7 +40,7 @@ $stream = imap_open("{your.imap.host}INBOX.Drafts", "username", "password"); $check = imap_check($stream); -echo "Msg Count before append: ". $check->Nmsgs."\n"; +echo "Msg Count before append: ". $check->Nmsgs . "\n"; imap_append($stream, "{your.imap.host}INBOX.Drafts" , "From: me@example.com\r\n" @@ -51,7 +51,7 @@ ); $check = imap_check($stream); -echo "Msg Count after append : ". $check->Nmsgs."\n"; +echo "Msg Count after append : ". $check->Nmsgs . "\n"; imap_close($stream); ?> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-body.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-body.xml diff -u phpdoc/en/reference/imap/functions/imap-body.xml:1.4 phpdoc/en/reference/imap/functions/imap-body.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-body.xml:1.4 Wed Feb 18 09:56:47 2004 +++ phpdoc/en/reference/imap/functions/imap-body.xml Mon Mar 8 04:18:40 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-body"> <refnamediv> @@ -17,22 +17,25 @@ <para> <function>imap_body</function> returns the body of the message, numbered <parameter>msg_number</parameter> in the current - mailbox. The optional <parameter>options</parameter> are a bit mask + mailbox. + </para> + <para> + The optional <parameter>options</parameter> are a bit mask with one or more of the following: <itemizedlist> <listitem> <simpara> - FT_UID - The <parameter>msgno</parameter> is a UID + <constant>FT_UID</constant> - The <parameter>msg_number</parameter> is a UID </simpara> </listitem> <listitem> <simpara> - FT_PEEK - Do not set the \Seen flag if not already set + <constant>FT_PEEK</constant> - Do not set the \Seen flag if not already set </simpara> </listitem> <listitem> <simpara> - FT_INTERNAL - The return string is in internal format, will + <constant>FT_INTERNAL</constant> - The return string is in internal format, will not canonicalize to CRLF. </simpara> </listitem> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-clearflag-full.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-clearflag-full.xml diff -u phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.4 phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.4 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-clearflag-full.xml Mon Mar 8 04:18:40 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-clearflag-full"> <refnamediv> @@ -16,20 +16,27 @@ <methodparam><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function causes a store to delete the specified flag to the - flags set for the messages in the specified sequence. + 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 RFC2060). + by RFC2060). &return.success;. </para> <para> - The options are a bit mask with one or more of the following: - <informalexample> - <literallayout> -ST_UID The sequence argument contains UIDs instead of - sequence numbers - </literallayout> - </informalexample> + <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> + <para> + See also: <function>imap_setflag_full</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-close.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/imap/functions/imap-close.xml diff -u phpdoc/en/reference/imap/functions/imap-close.xml:1.6 phpdoc/en/reference/imap/functions/imap-close.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-close.xml:1.6 Thu Feb 13 09:39:29 2003 +++ phpdoc/en/reference/imap/functions/imap-close.xml Mon Mar 8 04:18:40 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-close"> <refnamediv> @@ -15,9 +15,12 @@ </methodsynopsis> <para> Closes the imap stream. Takes an optional - <parameter>flag</parameter> CL_EXPUNGE, which will silently - expunge the mailbox before closing, removing all messages marked for - deletion. + <parameter>flag</parameter> <constant>CL_EXPUNGE</constant>, + which will silently expunge the mailbox before closing, + removing all messages marked for deletion. + </para> + <para> + See also: <function>imap_open</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-createmailbox.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/imap/functions/imap-createmailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.8 phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.8 Thu Dec 18 12:44:50 2003 +++ phpdoc/en/reference/imap/functions/imap-createmailbox.xml Mon Mar 8 04:18:40 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-createmailbox"> <refnamediv> @@ -19,13 +19,7 @@ international characters should be encoded by <function>imap_utf7_encode</function> </para> <para> - Returns &true; on success and &false; on error. - </para> - <para> - See also <function>imap_renamemailbox</function>, - <function>imap_deletemailbox</function> and - <function>imap_open</function> for the format - of <parameter>mbox</parameter> names. + &return.success;. </para> <para> <example> @@ -43,36 +37,38 @@ echo "Newname will be '$name1'<br />\n"; -# we will now create a new mailbox "phptestbox" in your inbox folder, -# check its status after creation and finaly remove it to restore -# your inbox to its initial state +// we will now create a new mailbox "phptestbox" in your inbox folder, +// check its status after creation and finaly remove it to restore +// your inbox to its initial state + if (@imap_createmailbox($mbox, imap_utf7_encode("{your.imap.host}INBOX.$newname"))) { - $status = @imap_status($mbox, "{your.imap.host}INBOX.$newname", SA_ALL); - if ($status) { - echo "your new mailbox '$name1' has the following status:<br />\n"; - echo "Messages: " . $status->messages . "<br />\n"; - echo "Recent: " . $status->recent . "<br />\n"; - echo "Unseen: " . $status->unseen . "<br />\n"; - echo "UIDnext: " . $status->uidnext . "<br />\n"; - echo "UIDvalidity:" . $status->uidvalidity . "<br />\n"; + $status = @imap_status($mbox, "{your.imap.host}INBOX.$newname", SA_ALL); + if ($status) { + echo "your new mailbox '$name1' has the following status:<br />\n"; + echo "Messages: " . $status->messages . "<br />\n"; + echo "Recent: " . $status->recent . "<br />\n"; + echo "Unseen: " . $status->unseen . "<br />\n"; + echo "UIDnext: " . $status->uidnext . "<br />\n"; + echo "UIDvalidity:" . $status->uidvalidity . "<br />\n"; + + if (imap_renamemailbox($mbox, "{your.imap.host}INBOX.$newname", "{your.imap.host}INBOX.$name2")) { + echo "renamed new mailbox from '$name1' to '$name2'<br />\n"; + $newname = $name2; + } else { + echo "imap_renamemailbox on new mailbox failed: " . imap_last_error() . "<br />\n"; + } + } else { + echo "imap_status on new mailbox failed: " . imap_last_error() . "<br />\n"; + } - if (imap_renamemailbox($mbox, "{your.imap.host}INBOX.$newname", "{your.imap.host}INBOX.$name2")) { - echo "renamed new mailbox from '$name1' to '$name2'<br />\n"; - $newname=$name2; + if (@imap_deletemailbox($mbox, "{your.imap.host}INBOX.$newname")) { + echo "new mailbox removed to restore initial state<br />\n"; } else { - echo "imap_renamemailbox on new mailbox failed: " . imap_last_error() . "<br />\n"; + echo "imap_deletemailbox on new mailbox failed: " . implode("<br />\n", imap_errors()) . "<br />\n"; } - } else { - echo "imap_status on new mailbox failed: " . imap_last_error() . "<br />\n"; - } - if (@imap_deletemailbox($mbox, "{your.imap.host}INBOX.$newname")) { - echo "new mailbox removed to restore initial state<br />\n"; - } else { - echo "imap_deletemailbox on new mailbox failed: " . implode("<br />\n", imap_errors()) . "<br />\n"; - } - + } else { - echo "could not create new mailbox: " . implode("<br />\n", imap_errors()) . "<br />\n"; + echo "could not create new mailbox: " . implode("<br />\n", imap_errors()) . "<br />\n"; } imap_close($mbox); @@ -81,6 +77,12 @@ </programlisting> </example> </para> + <para> + See also <function>imap_renamemailbox</function>, + <function>imap_deletemailbox</function> and + <function>imap_open</function> for the format + of <parameter>mbox</parameter> names. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-delete.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/imap/functions/imap-delete.xml diff -u phpdoc/en/reference/imap/functions/imap-delete.xml:1.7 phpdoc/en/reference/imap/functions/imap-delete.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-delete.xml:1.7 Wed Dec 17 09:32:31 2003 +++ phpdoc/en/reference/imap/functions/imap-delete.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-delete"> <refnamediv> @@ -45,23 +45,34 @@ <programlisting role="php"> <![CDATA[ <?php + $mbox = imap_open("{your.imap.host}INBOX", "username", "password") or die("Can't connect: " . imap_last_error()); $check = imap_mailboxmsginfo($mbox); echo "Messages before delete: " . $check->Nmsgs . "<br />\n"; + imap_delete($mbox, 1); + $check = imap_mailboxmsginfo($mbox); echo "Messages after delete: " . $check->Nmsgs . "<br />\n"; + imap_expunge($mbox); + $check = imap_mailboxmsginfo($mbox); echo "Messages after expunge: " . $check->Nmsgs . "<br />\n"; + imap_close($mbox); ?> ]]> </programlisting> </example> </para> + <para> + See also: <function>imap_undelete</function>, + <function>imap_expunge</function>, and + <function>imap_close</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-deletemailbox.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-deletemailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.3 phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-deletemailbox.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-deletemailbox"> <refnamediv> @@ -19,7 +19,7 @@ of <parameter>mbox</parameter> names). </para> <para> - Returns &true; on success and &false; on error. + &return.success;. </para> <para> See also <function>imap_createmailbox</function>, http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-errors.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/imap/functions/imap-errors.xml diff -u phpdoc/en/reference/imap/functions/imap-errors.xml:1.2 phpdoc/en/reference/imap/functions/imap-errors.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-errors.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-errors.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-errors"> <refnamediv> @@ -23,6 +23,9 @@ <function>imap_errors</function> is called, the error stack is subsequently cleared. </para> + <para> + See also: <function>imap_last_error</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-fetchbody.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-fetchbody.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.3 phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-fetchbody.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-fetchbody"> <refnamediv> @@ -25,23 +25,25 @@ IMAP4 specification. Body parts are not decoded by this function. </para> <para> - The options for <function>imap_fetchbody</function> is a bitmask - with one or more of the following: + The <parameter>options</parameter> for + <function>imap_fetchbody</function> is a bitmask with one or more + of the following: <itemizedlist> <listitem> <simpara> - FT_UID - The <parameter>msg_number</parameter> is a UID + <constant>FT_UID</constant> - The <parameter>msg_number</parameter> is a UID </simpara> </listitem> <listitem> <simpara> - FT_PEEK - Do not set the \Seen flag if not already set + <constant>FT_PEEK</constant> - Do not set the \Seen flag if + not already set </simpara> </listitem> <listitem> <simpara> - FT_INTERNAL - The return string is in "internal" format, - without any attempt to canonicalize CRLF. + <constant>FT_INTERNAL</constant> - The return string is in + internal format, will not canonicalize to CRLF. </simpara> </listitem> </itemizedlist> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-fetchheader.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-fetchheader.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.5 phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.5 Tue Feb 17 16:57:01 2004 +++ phpdoc/en/reference/imap/functions/imap-fetchheader.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-fetchheader"> <refnamediv> @@ -21,20 +21,30 @@ returns that text string. </para> <para> - The options are: - <informalexample> - <literallayout> -FT_UID The msgno argument is a UID -FT_INTERNAL The return string is in "internal" format, - without any attempt to canonicalize to CRLF - newlines -FT_PREFETCHTEXT 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) - </literallayout> - </informalexample> + 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> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-getacl.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/imap/functions/imap-getacl.xml diff -u phpdoc/en/reference/imap/functions/imap-getacl.xml:1.1 phpdoc/en/reference/imap/functions/imap-getacl.xml:1.2 --- phpdoc/en/reference/imap/functions/imap-getacl.xml:1.1 Sun Nov 2 13:00:47 2003 +++ phpdoc/en/reference/imap/functions/imap-getacl.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.imap-getacl"> <refnamediv> <refname>imap_getacl</refname> @@ -17,6 +17,9 @@ &warn.undocumented.func; + <para> + See also: <function>imap_setacl</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-getmailboxes.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-getmailboxes.xml diff -u phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.5 phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.5 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-getmailboxes.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-getmailboxes"> <refnamediv> @@ -28,25 +28,26 @@ <itemizedlist> <listitem> <simpara> - LATT_NOINFERIORS - This mailbox has no "children" (there are - no mailboxes below this one). + <constant>LATT_NOINFERIORS</constant> - This mailbox has no + "children" (there are no mailboxes below this one). </simpara> </listitem> <listitem> <simpara> - LATT_NOSELECT - This is only a container, not a mailbox - you - cannot open it. + <constant>LATT_NOSELECT</constant> - This is only a container, + not a mailbox - you cannot open it. </simpara> </listitem> <listitem> <simpara> - LATT_MARKED - This mailbox is marked. Only used by UW-IMAPD. + <constant>LATT_MARKED</constant> - This mailbox is marked. + Only used by UW-IMAPD. </simpara> </listitem> <listitem> <simpara> - LATT_UNMARKED - This mailbox is not marked. Only used by - UW-IMAPD. + <constant>LATT_UNMARKED</constant> - This mailbox is not marked. + Only used by UW-IMAPD. </simpara> </listitem> </itemizedlist> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-last-error.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/imap/functions/imap-last-error.xml diff -u phpdoc/en/reference/imap/functions/imap-last-error.xml:1.2 phpdoc/en/reference/imap/functions/imap-last-error.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-last-error.xml:1.2 Wed Apr 17 02:39:19 2002 +++ phpdoc/en/reference/imap/functions/imap-last-error.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-last-error"> <refnamediv> @@ -22,6 +22,9 @@ subsequently, with no intervening errors, will return the same error. </para> + <para> + See also: <function>imap_errors</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-list.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-list.xml diff -u phpdoc/en/reference/imap/functions/imap-list.xml:1.3 phpdoc/en/reference/imap/functions/imap-list.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-list.xml:1.3 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-list.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.imap-list"> <refnamediv> <refname>imap_list</refname> @@ -30,8 +30,9 @@ $list = imap_list($mbox, "{your.imap.host}", "*"); if (is_array($list)) { reset($list); - while (list($key, $val) = each($list)) + while (list($key, $val) = each($list)) { echo imap_utf7_decode($val) . "<br />\n"; + } } else { echo "imap_list failed: " . imap_last_error() . "\n"; } @@ -42,6 +43,9 @@ </programlisting> </example> </para> + <para> + See also: <function>imap_getmailboxes</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-listscan.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/imap/functions/imap-listscan.xml diff -u phpdoc/en/reference/imap/functions/imap-listscan.xml:1.1 phpdoc/en/reference/imap/functions/imap-listscan.xml:1.2 --- phpdoc/en/reference/imap/functions/imap-listscan.xml:1.1 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-listscan.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.imap-listscan"> <refnamediv> <refname>imap_listscan</refname> @@ -20,9 +20,13 @@ <para> Returns an array containing the names of the mailboxes that have <parameter>content</parameter> in the text of the mailbox. + </para> + <para> This function is similar to <function>imap_listmailbox</function>, but it will additionally check for the presence of the string <parameter>content</parameter> inside the mailbox data. + </para> + <para> See <function>imap_getmailboxes</function> for a description of <parameter>ref</parameter> and <parameter>pattern</parameter>. </para> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-mail-compose.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-mail-compose.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.5 phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.5 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-mail-compose.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-mail-compose"> <refnamediv> @@ -24,32 +24,32 @@ <![CDATA[ <?php -$envelope["from"]="joe@example.com"; -$envelope["to"]="foo@example.com"; -$envelope["cc"]="bar@example.com"; - -$part1["type"]=TYPEMULTIPART; -$part1["subtype"]="mixed"; - -$filename="/tmp/imap.c.gz"; -$fp=fopen($filename, "r"); -$contents=fread($fp, filesize($filename)); +$envelope["from"]= "joe@example.com"; +$envelope["to"] = "foo@example.com"; +$envelope["cc"] = "bar@example.com"; + +$part1["type"] = TYPEMULTIPART; +$part1["subtype"] = "mixed"; + +$filename = "/tmp/imap.c.gz"; +$fp = fopen($filename, "r"); +$contents = fread($fp, filesize($filename)); fclose($fp); -$part2["type"]=TYPEAPPLICATION; -$part2["encoding"]=ENCBINARY; -$part2["subtype"]="octet-stream"; -$part2["description"]=basename($filename); -$part2["contents.data"]=$contents; - -$part3["type"]=TYPETEXT; -$part3["subtype"]="plain"; -$part3["description"]="description3"; -$part3["contents.data"]="contents.data3\n\n\n\t"; - -$body[1]=$part1; -$body[2]=$part2; -$body[3]=$part3; +$part2["type"] = TYPEAPPLICATION; +$part2["encoding"] = ENCBINARY; +$part2["subtype"] = "octet-stream"; +$part2["description"] = basename($filename); +$part2["contents.data"] = $contents; + +$part3["type"] = TYPETEXT; +$part3["subtype"] = "plain"; +$part3["description"] = "description3"; +$part3["contents.data"] = "contents.data3\n\n\n\t"; + +$body[1] = $part1; +$body[2] = $part2; +$body[3] = $part3; echo nl2br(imap_mail_compose($envelope, $body)); http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-mail-copy.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-mail-copy.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.4 phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.4 Wed May 7 17:31:30 2003 +++ phpdoc/en/reference/imap/functions/imap-mail-copy.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-mail-copy"> <refnamediv> @@ -15,31 +15,33 @@ <methodparam><type>string</type><parameter>mbox</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> - <para> - Returns &true; on success and &false; on error. - </para> <para> Copies mail messages specified by <parameter>msglist</parameter> - to specified mailbox. <parameter>msglist</parameter> is a range - not just message numbers (as described in - <ulink url="&url.rfc;2060">RFC2060</ulink>). + to specified mailbox. &return.success;. + </para> + <para> + <parameter>msglist</parameter> is a range not just message + numbers (as described in <ulink url="&url.rfc;2060">RFC2060</ulink>). </para> <para> - Flags is a bitmask of one or more of + <parameter>options</parameter> is a bitmask of one or more of <itemizedlist> <listitem> <simpara> - CP_UID - the sequence numbers contain UIDS + <constant>CP_UID</constant> - the sequence numbers contain UIDS </simpara> </listitem> <listitem> <simpara> - CP_MOVE - Delete the messages from the current mailbox after - copying + <constant>CP_MOVE</constant> - Delete the messages from + the current mailbox after copying </simpara> </listitem> </itemizedlist> </para> + <para> + See also <function>imap_mail_move</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-mail-move.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-mail-move.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.5 phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.5 Wed May 7 17:31:30 2003 +++ phpdoc/en/reference/imap/functions/imap-mail-move.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-mail-move"> <refnamediv> @@ -17,23 +17,25 @@ </methodsynopsis> <para> Moves mail messages specified by <parameter>msglist</parameter> - to specified mailbox <parameter>mbox</parameter>. <parameter>msglist</parameter> - is a range not just message numbers (as described in - <ulink url="&url.rfc;2060">RFC2060</ulink>). + to specified mailbox <parameter>mbox</parameter>. &return.success;. </para> <para> - &return.success; + <parameter>msglist</parameter> is a range not just message numbers + (as described in <ulink url="&url.rfc;2060">RFC2060</ulink>). </para> <para> - <parameter>options</parameter> is a bitmask and may contain the single option + <parameter>options</parameter> is a bitmask and may contain the single option: <itemizedlist> <listitem> <simpara> - CP_UID - the sequence numbers contain UIDS + <constant>CP_UID</constant> - the sequence numbers contain UIDS </simpara> </listitem> </itemizedlist> </para> + <para> + See also <function>imap_mail_copy</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-mail.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-mail.xml diff -u phpdoc/en/reference/imap/functions/imap-mail.xml:1.4 phpdoc/en/reference/imap/functions/imap-mail.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-mail.xml:1.4 Sat Dec 20 20:22:51 2003 +++ phpdoc/en/reference/imap/functions/imap-mail.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-mail"> <refnamediv> @@ -21,11 +21,21 @@ <methodparam choice="opt"><type>string</type><parameter>rpath</parameter></methodparam> </methodsynopsis> <para> - This function allows sending of emails with correct handling of Cc and Bcc receivers. - The parameters to, cc and bcc are all strings and are all parsed as rfc822 address lists. - The receivers specified in bcc will get the mail, but are excluded from the headers. - Use the rpath parameter to specify return path. This is useful when using PHP as a mail client - for multiple users. + This function allows sending of emails with correct handling of + Cc and Bcc receivers. &return.success;. + </para> + <para> + The parameters <parameter>to</parameter>, <parameter>cc</parameter> + and <parameter>bcc</parameter> are all strings and are all parsed + as rfc822 address lists. + </para> + <para> + The receivers specified in <parameter>bcc</parameter> will get the + mail, but are excluded from the headers. + </para> + <para> + Use the <parameter>rpath</parameter> parameter to specify return path. + This is useful when using PHP as a mail client for multiple users. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml?r1=1.6&r2=1.7&ty=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.6 phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml:1.6 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-mime-header-decode"> <refnamediv> @@ -17,7 +17,7 @@ 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" & "text". + where each object has two properties, "charset" and "text". 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". http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-msgno.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-msgno.xml diff -u phpdoc/en/reference/imap/functions/imap-msgno.xml:1.3 phpdoc/en/reference/imap/functions/imap-msgno.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-msgno.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-msgno.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-msgno"> <refnamediv> @@ -18,7 +18,11 @@ </methodsynopsis> <para> This function returns the message sequence number for the given - UID. It is the inverse of <function>imap_uid</function>. + <parameter>uid</parameter>. It is the inverse of + <function>imap_uid</function>. + </para> + <para> + See also <function>imap_uid</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-open.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/imap/functions/imap-open.xml diff -u phpdoc/en/reference/imap/functions/imap-open.xml:1.6 phpdoc/en/reference/imap/functions/imap-open.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-open.xml:1.6 Wed Dec 17 09:32:31 2003 +++ phpdoc/en/reference/imap/functions/imap-open.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-open"> <refnamediv> @@ -33,28 +33,30 @@ with <function>imap_utf7_encode</function>. </para> <para> - The options are a bit mask with one or more of the following: + The <parameter>options</parameter> are a bit mask with one or more of the following: <itemizedlist> <listitem> <simpara> - OP_READONLY - Open mailbox read-only + <constant>OP_READONLY</constant> - Open mailbox read-only </simpara> </listitem> <listitem> <simpara> - OP_ANONYMOUS - Don't use or update a + <constant>OP_ANONYMOUS</constant> - Don't use or update a <filename>.newsrc</filename> for news (NNTP only) </simpara> </listitem> <listitem> <simpara> - OP_HALFOPEN - For IMAP and NNTP names, open a connection but - don't open a mailbox + <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but + don't open a mailbox. </simpara> - </listitem> + </listitem> <listitem> <simpara> - CL_EXPUNGE - Expunge mailbox automatically upon mailbox close + <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close + (see also <function>imap_delete</function> and + <function>imap_expunge</function>) </simpara> </listitem> </itemizedlist> @@ -124,7 +126,7 @@ <?php $mbox = imap_open("{your.imap.host:143}", "username", "password"); -echo "<p><h1>Mailboxes</h1>\n"; +echo "<h1>Mailboxes</h1>\n"; $folders = imap_listmailbox($mbox, "{your.imap.host:143}", "*"); if ($folders == false) { @@ -135,7 +137,7 @@ } } -echo "<p><h1>Headers in INBOX</h1>\n"; +echo "<h1>Headers in INBOX</h1>\n"; $headers = imap_headers($mbox); if ($headers == false) { http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-qprint.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-qprint.xml diff -u phpdoc/en/reference/imap/functions/imap-qprint.xml:1.3 phpdoc/en/reference/imap/functions/imap-qprint.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-qprint.xml:1.3 Wed May 7 17:31:30 2003 +++ phpdoc/en/reference/imap/functions/imap-qprint.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-qprint"> <refnamediv> @@ -19,9 +19,6 @@ 6.7). </para> <para> - Returns an 8 bit (binary) string. - </para> - <para> See also <function>imap_8bit</function>. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-reopen.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-reopen.xml diff -u phpdoc/en/reference/imap/functions/imap-reopen.xml:1.5 phpdoc/en/reference/imap/functions/imap-reopen.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-reopen.xml:1.5 Wed Dec 17 09:32:31 2003 +++ phpdoc/en/reference/imap/functions/imap-reopen.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-reopen"> <refnamediv> @@ -15,32 +15,32 @@ <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function reopens the specified stream to a new mailbox on - an IMAP or NNTP server. + This function reopens the specified stream to a new + <parameter>mailbox</parameter> on an IMAP or NNTP server. </para> <para> - The options are a bit mask with one or more of the following: + The <parameter>options</parameter> are a bit mask with one or more of the following: <itemizedlist> <listitem> <simpara> - OP_READONLY - Open mailbox read-only + <constant>OP_READONLY</constant> - Open mailbox read-only </simpara> </listitem> <listitem> <simpara> - OP_ANONYMOUS - Don't use or update a + <constant>OP_ANONYMOUS</constant> - Don't use or update a <filename>.newsrc</filename> for news (NNTP only) </simpara> </listitem> <listitem> <simpara> - OP_HALFOPEN - For IMAP and NNTP names, open a connection but + <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but don't open a mailbox. </simpara> </listitem> <listitem> <simpara> - CL_EXPUNGE - Expunge mailbox automatically upon mailbox close + <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close (see also <function>imap_delete</function> and <function>imap_expunge</function>) </simpara> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml?r1=1.7&r2=1.8&ty=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.7 phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml:1.7 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-rfc822-parse-adrlist"> <refnamediv> @@ -49,9 +49,12 @@ <programlisting role="php"> <![CDATA[ <?php + $address_string = "Joe Doe <doe@example.com>, postmaster@example.com, root"; $address_array = imap_rfc822_parse_adrlist($address_string, "example.com"); -if (!is_array($address_array) || count($address_array) < 1) die("something is wrong\n"); +if (!is_array($address_array) || count($address_array) < 1) { + die("something is wrong\n"); +} foreach ($address_array as $val) { echo "mailbox : " . $val->mailbox . "<br />\n"; http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml?r1=1.6&r2=1.7&ty=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.6 phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml:1.6 Thu Dec 18 12:44:50 2003 +++ phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-rfc822-write-address"> <refnamediv> @@ -20,7 +20,8 @@ <para> Returns a properly formatted email address as defined in <ulink url="&url.rfc;2822">RFC2822</ulink> - given the mailbox, host, and personal info. + given the <parameter>mailbox</parameter>, <parameter>host</parameter>, + and <parameter>personal</parameter> info. </para> <para> <example> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-setacl.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-setacl.xml diff -u phpdoc/en/reference/imap/functions/imap-setacl.xml:1.3 phpdoc/en/reference/imap/functions/imap-setacl.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-setacl.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-setacl.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 --> <refentry id='function.imap-setacl'> <refnamediv> @@ -20,6 +20,9 @@ <para> &warn.undocumented.func; </para> + <para> + See also: <function>imap_getacl</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-setflag-full.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/imap/functions/imap-setflag-full.xml diff -u phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.7 phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.7 Thu Dec 18 12:44:50 2003 +++ phpdoc/en/reference/imap/functions/imap-setflag-full.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-setflag-full"> <refnamediv> @@ -16,8 +16,9 @@ <methodparam><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function causes a store to add the specified flag to the - flags set for the messages in the specified sequence. + 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>. </para> <para> The flags which you can set are "\\Seen", "\\Answered", @@ -25,13 +26,16 @@ by RFC2060). </para> <para> - The options are a bit mask with one or more of the following: - <informalexample> - <literallayout> -ST_UID The sequence argument contains UIDs instead of - sequence numbers - </literallayout> - </informalexample> + <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> <para> <example> @@ -52,7 +56,10 @@ ]]> </programlisting> </example> - </para> + </para> + <para> + See also: <function>imap_clearflag_full</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-sort.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-sort.xml diff -u phpdoc/en/reference/imap/functions/imap-sort.xml:1.3 phpdoc/en/reference/imap/functions/imap-sort.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-sort.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-sort.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-sort"> <refnamediv> @@ -25,26 +25,58 @@ </para> <para> Criteria can be one (and only one) of the following: - <informalexample> - <literallayout> -SORTDATE message Date -SORTARRIVAL arrival date -SORTFROM mailbox in first From address -SORTSUBJECT message Subject -SORTTO mailbox in first To address -SORTCC mailbox in first cc address -SORTSIZE size of message in octets - </literallayout> - </informalexample> + <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> <para> The flags are a bitmask of one or more of the following: - <informalexample> - <literallayout> -SE_UID Return UIDs instead of sequence numbers -SE_NOPREFETCH Don't prefetch searched messages. - </literallayout> - </informalexample> + <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> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-status.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/imap/functions/imap-status.xml diff -u phpdoc/en/reference/imap/functions/imap-status.xml:1.7 phpdoc/en/reference/imap/functions/imap-status.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-status.xml:1.7 Thu Dec 18 12:44:50 2003 +++ phpdoc/en/reference/imap/functions/imap-status.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-status"> <refnamediv> @@ -78,9 +78,10 @@ echo "Unseen: " . $status->unseen . "<br />\n"; echo "UIDnext: " . $status->uidnext . "<br />\n"; echo "UIDvalidity:" . $status->uidvalidity . "<br />\n"; -} else +} else { echo "imap_status failed: " . imap_last_error() . "\n"; - +} + imap_close($mbox); ?> ]]> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-subscribe.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-subscribe.xml diff -u phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.4 phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.4 Wed Feb 5 22:32:42 2003 +++ phpdoc/en/reference/imap/functions/imap-subscribe.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.7 --> <refentry id="function.imap-subscribe"> <refnamediv> @@ -19,6 +19,9 @@ <para> &return.success; </para> + <para> + See also: <function>imap_unsubscribe</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-uid.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-uid.xml diff -u phpdoc/en/reference/imap/functions/imap-uid.xml:1.3 phpdoc/en/reference/imap/functions/imap-uid.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-uid.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-uid.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-uid"> <refnamediv> @@ -28,6 +28,9 @@ This is not supported by POP3 mailboxes. </para> </note> + <para> + See also: <function>imap_msgno</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-undelete.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-undelete.xml diff -u phpdoc/en/reference/imap/functions/imap-undelete.xml:1.4 phpdoc/en/reference/imap/functions/imap-undelete.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-undelete.xml:1.4 Wed Feb 5 22:32:42 2003 +++ phpdoc/en/reference/imap/functions/imap-undelete.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-undelete"> <refnamediv> @@ -23,6 +23,11 @@ <para> &return.success; </para> + <para> + See also: + <function>imap_delete</function>, and + <function>imap_mail_move</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-unsubscribe.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-unsubscribe.xml diff -u phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.4 phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.4 Wed Feb 5 22:32:42 2003 +++ phpdoc/en/reference/imap/functions/imap-unsubscribe.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-unsubscribe"> <refnamediv> @@ -19,6 +19,9 @@ <para> &return.success; </para> + <para> + See also: <function>imap_subscribe</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-utf7-decode.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-utf7-decode.xml diff -u phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.5 phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.5 Wed Dec 17 09:32:31 2003 +++ phpdoc/en/reference/imap/functions/imap-utf7-decode.xml Mon Mar 8 04:18:45 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.16 --> <refentry id="function.imap-utf7-decode"> <refnamediv> @@ -23,13 +23,20 @@ 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> + <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 + <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>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-utf7-encode.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/imap/functions/imap-utf7-encode.xml diff -u phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.6 phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.6 Wed Dec 17 09:32:31 2003 +++ phpdoc/en/reference/imap/functions/imap-utf7-encode.xml Mon Mar 8 04:18:45 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-utf7-encode"> <refnamediv> @@ -16,16 +16,21 @@ </methodsynopsis> <para> Converts <parameter>data</parameter> to modified UTF-7 - text. This is needed to encode mailbox names that contain certain + text. Note that <parameter>data</parameter> is expected to be + encoded in ISO-8859-1. + </para> + <para> + This is needed to encode mailbox names that contain certain characters which are not in range of printable ASCII characters. - Note that <parameter>data</parameter> is expected to be - encoded in ISO-8859-1. The modified UTF-7 encoding is defined in <ulink + </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> - Returns the modified UTF-7 text. + See also: <function>imap_utf7_decode</function>. </para> </refsect1> </refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/imap/constants.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/imap/constants.xml diff -u phpdoc/en/reference/imap/constants.xml:1.2 phpdoc/en/reference/imap/constants.xml:1.3 --- phpdoc/en/reference/imap/constants.xml:1.2 Wed May 28 19:03:08 2003 +++ phpdoc/en/reference/imap/constants.xml Mon Mar 8 04:18:35 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <section id="imap.constants"> &reftitle.constants; &extension.constants; @@ -33,7 +33,7 @@ </term> <listitem> <simpara> - + Open mailbox read-only </simpara> </listitem> </varlistentry> @@ -44,7 +44,8 @@ </term> <listitem> <simpara> - + Don't use or update a <filename>.newsrc</filename> for news + (NNTP only) </simpara> </listitem> </varlistentry> @@ -88,7 +89,7 @@ </term> <listitem> <simpara> - + For IMAP and NNTP names, open a connection but don't open a mailbox. </simpara> </listitem> </varlistentry> @@ -121,7 +122,8 @@ </term> <listitem> <simpara> - + silently expunge the mailbox before closing when + calling <function>imap_close</function> </simpara> </listitem> </varlistentry> @@ -132,7 +134,7 @@ </term> <listitem> <simpara> - + The parameter is a UID </simpara> </listitem> </varlistentry> @@ -143,7 +145,7 @@ </term> <listitem> <simpara> - + Do not set the \Seen flag if not already set </simpara> </listitem> </varlistentry> @@ -165,7 +167,7 @@ </term> <listitem> <simpara> - + The return string is in internal format, will not canonicalize to CRLF. </simpara> </listitem> </varlistentry> @@ -187,7 +189,7 @@ </term> <listitem> <simpara> - + The sequence argument contains UIDs instead of sequence numbers </simpara> </listitem> </varlistentry> @@ -220,7 +222,7 @@ </term> <listitem> <simpara> - + the sequence numbers contain UIDS </simpara> </listitem> </varlistentry> @@ -231,7 +233,8 @@ </term> <listitem> <simpara> - + Delete the messages from the current mailbox after copying + with <function>imap_mail_copy</function> </simpara> </listitem> </varlistentry> @@ -242,7 +245,7 @@ </term> <listitem> <simpara> - + Return UIDs instead of sequence numbers </simpara> </listitem> </varlistentry> @@ -264,7 +267,7 @@ </term> <listitem> <simpara> - + Don't prefetch searched messages </simpara> </listitem> </varlistentry> @@ -363,7 +366,8 @@ </term> <listitem> <simpara> - + This mailbox has no "children" (there are no + mailboxes below this one). </simpara> </listitem> </varlistentry> @@ -374,7 +378,8 @@ </term> <listitem> <simpara> - + This is only a container, not a mailbox - you + cannot open it. </simpara> </listitem> </varlistentry> @@ -385,7 +390,7 @@ </term> <listitem> <simpara> - + This mailbox is marked. Only used by UW-IMAPD. </simpara> </listitem> </varlistentry> @@ -396,7 +401,8 @@ </term> <listitem> <simpara> - + This mailbox is not marked. Only used by + UW-IMAPD. </simpara> </listitem> </varlistentry> @@ -407,7 +413,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + message Date </simpara> </listitem> </varlistentry> @@ -418,7 +425,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + arrival date </simpara> </listitem> </varlistentry> @@ -429,7 +437,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + mailbox in first From address </simpara> </listitem> </varlistentry> @@ -440,7 +449,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + message subject </simpara> </listitem> </varlistentry> @@ -451,7 +461,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + mailbox in first To address </simpara> </listitem> </varlistentry> @@ -462,7 +473,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + mailbox in first cc address </simpara> </listitem> </varlistentry> @@ -473,7 +485,8 @@ </term> <listitem> <simpara> - + Sort criteria for <function>imap_sort</function>: + size of message in octets </simpara> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-append.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/imap/functions/imap-append.xml diff -u phpdoc/en/reference/imap/functions/imap-append.xml:1.8 phpdoc/en/reference/imap/functions/imap-append.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-append.xml:1.8 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-append.xml Mon Mar 8 04:18:40 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-append"> <refnamediv> @@ -40,7 +40,7 @@ $stream = imap_open("{your.imap.host}INBOX.Drafts", "username", "password"); $check = imap_check($stream); -echo "Msg Count before append: ". $check->Nmsgs."\n"; +echo "Msg Count before append: ". $check->Nmsgs . "\n"; imap_append($stream, "{your.imap.host}INBOX.Drafts" , "From: me@example.com\r\n" @@ -51,7 +51,7 @@ ); $check = imap_check($stream); -echo "Msg Count after append : ". $check->Nmsgs."\n"; +echo "Msg Count after append : ". $check->Nmsgs . "\n"; imap_close($stream); ?> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-body.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-body.xml diff -u phpdoc/en/reference/imap/functions/imap-body.xml:1.4 phpdoc/en/reference/imap/functions/imap-body.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-body.xml:1.4 Wed Feb 18 09:56:47 2004 +++ phpdoc/en/reference/imap/functions/imap-body.xml Mon Mar 8 04:18:40 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-body"> <refnamediv> @@ -17,22 +17,25 @@ <para> <function>imap_body</function> returns the body of the message, numbered <parameter>msg_number</parameter> in the current - mailbox. The optional <parameter>options</parameter> are a bit mask + mailbox. + </para> + <para> + The optional <parameter>options</parameter> are a bit mask with one or more of the following: <itemizedlist> <listitem> <simpara> - FT_UID - The <parameter>msgno</parameter> is a UID + <constant>FT_UID</constant> - The <parameter>msg_number</parameter> is a UID </simpara> </listitem> <listitem> <simpara> - FT_PEEK - Do not set the \Seen flag if not already set + <constant>FT_PEEK</constant> - Do not set the \Seen flag if not already set </simpara> </listitem> <listitem> <simpara> - FT_INTERNAL - The return string is in internal format, will + <constant>FT_INTERNAL</constant> - The return string is in internal format, will not canonicalize to CRLF. </simpara> </listitem> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-clearflag-full.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-clearflag-full.xml diff -u phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.4 phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.4 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-clearflag-full.xml Mon Mar 8 04:18:40 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-clearflag-full"> <refnamediv> @@ -16,20 +16,27 @@ <methodparam><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function causes a store to delete the specified flag to the - flags set for the messages in the specified sequence. + 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 RFC2060). + by RFC2060). &return.success;. </para> <para> - The options are a bit mask with one or more of the following: - <informalexample> - <literallayout> -ST_UID The sequence argument contains UIDs instead of - sequence numbers - </literallayout> - </informalexample> + <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> + <para> + See also: <function>imap_setflag_full</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-close.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/imap/functions/imap-close.xml diff -u phpdoc/en/reference/imap/functions/imap-close.xml:1.6 phpdoc/en/reference/imap/functions/imap-close.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-close.xml:1.6 Thu Feb 13 09:39:29 2003 +++ phpdoc/en/reference/imap/functions/imap-close.xml Mon Mar 8 04:18:40 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-close"> <refnamediv> @@ -15,9 +15,12 @@ </methodsynopsis> <para> Closes the imap stream. Takes an optional - <parameter>flag</parameter> CL_EXPUNGE, which will silently - expunge the mailbox before closing, removing all messages marked for - deletion. + <parameter>flag</parameter> <constant>CL_EXPUNGE</constant>, + which will silently expunge the mailbox before closing, + removing all messages marked for deletion. + </para> + <para> + See also: <function>imap_open</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-createmailbox.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/imap/functions/imap-createmailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.8 phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.8 Thu Dec 18 12:44:50 2003 +++ phpdoc/en/reference/imap/functions/imap-createmailbox.xml Mon Mar 8 04:18:40 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-createmailbox"> <refnamediv> @@ -19,13 +19,7 @@ international characters should be encoded by <function>imap_utf7_encode</function> </para> <para> - Returns &true; on success and &false; on error. - </para> - <para> - See also <function>imap_renamemailbox</function>, - <function>imap_deletemailbox</function> and - <function>imap_open</function> for the format - of <parameter>mbox</parameter> names. + &return.success;. </para> <para> <example> @@ -43,36 +37,38 @@ echo "Newname will be '$name1'<br />\n"; -# we will now create a new mailbox "phptestbox" in your inbox folder, -# check its status after creation and finaly remove it to restore -# your inbox to its initial state +// we will now create a new mailbox "phptestbox" in your inbox folder, +// check its status after creation and finaly remove it to restore +// your inbox to its initial state + if (@imap_createmailbox($mbox, imap_utf7_encode("{your.imap.host}INBOX.$newname"))) { - $status = @imap_status($mbox, "{your.imap.host}INBOX.$newname", SA_ALL); - if ($status) { - echo "your new mailbox '$name1' has the following status:<br />\n"; - echo "Messages: " . $status->messages . "<br />\n"; - echo "Recent: " . $status->recent . "<br />\n"; - echo "Unseen: " . $status->unseen . "<br />\n"; - echo "UIDnext: " . $status->uidnext . "<br />\n"; - echo "UIDvalidity:" . $status->uidvalidity . "<br />\n"; + $status = @imap_status($mbox, "{your.imap.host}INBOX.$newname", SA_ALL); + if ($status) { + echo "your new mailbox '$name1' has the following status:<br />\n"; + echo "Messages: " . $status->messages . "<br />\n"; + echo "Recent: " . $status->recent . "<br />\n"; + echo "Unseen: " . $status->unseen . "<br />\n"; + echo "UIDnext: " . $status->uidnext . "<br />\n"; + echo "UIDvalidity:" . $status->uidvalidity . "<br />\n"; + + if (imap_renamemailbox($mbox, "{your.imap.host}INBOX.$newname", "{your.imap.host}INBOX.$name2")) { + echo "renamed new mailbox from '$name1' to '$name2'<br />\n"; + $newname = $name2; + } else { + echo "imap_renamemailbox on new mailbox failed: " . imap_last_error() . "<br />\n"; + } + } else { + echo "imap_status on new mailbox failed: " . imap_last_error() . "<br />\n"; + } - if (imap_renamemailbox($mbox, "{your.imap.host}INBOX.$newname", "{your.imap.host}INBOX.$name2")) { - echo "renamed new mailbox from '$name1' to '$name2'<br />\n"; - $newname=$name2; + if (@imap_deletemailbox($mbox, "{your.imap.host}INBOX.$newname")) { + echo "new mailbox removed to restore initial state<br />\n"; } else { - echo "imap_renamemailbox on new mailbox failed: " . imap_last_error() . "<br />\n"; + echo "imap_deletemailbox on new mailbox failed: " . implode("<br />\n", imap_errors()) . "<br />\n"; } - } else { - echo "imap_status on new mailbox failed: " . imap_last_error() . "<br />\n"; - } - if (@imap_deletemailbox($mbox, "{your.imap.host}INBOX.$newname")) { - echo "new mailbox removed to restore initial state<br />\n"; - } else { - echo "imap_deletemailbox on new mailbox failed: " . implode("<br />\n", imap_errors()) . "<br />\n"; - } - + } else { - echo "could not create new mailbox: " . implode("<br />\n", imap_errors()) . "<br />\n"; + echo "could not create new mailbox: " . implode("<br />\n", imap_errors()) . "<br />\n"; } imap_close($mbox); @@ -81,6 +77,12 @@ </programlisting> </example> </para> + <para> + See also <function>imap_renamemailbox</function>, + <function>imap_deletemailbox</function> and + <function>imap_open</function> for the format + of <parameter>mbox</parameter> names. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-delete.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/imap/functions/imap-delete.xml diff -u phpdoc/en/reference/imap/functions/imap-delete.xml:1.7 phpdoc/en/reference/imap/functions/imap-delete.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-delete.xml:1.7 Wed Dec 17 09:32:31 2003 +++ phpdoc/en/reference/imap/functions/imap-delete.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-delete"> <refnamediv> @@ -45,23 +45,34 @@ <programlisting role="php"> <![CDATA[ <?php + $mbox = imap_open("{your.imap.host}INBOX", "username", "password") or die("Can't connect: " . imap_last_error()); $check = imap_mailboxmsginfo($mbox); echo "Messages before delete: " . $check->Nmsgs . "<br />\n"; + imap_delete($mbox, 1); + $check = imap_mailboxmsginfo($mbox); echo "Messages after delete: " . $check->Nmsgs . "<br />\n"; + imap_expunge($mbox); + $check = imap_mailboxmsginfo($mbox); echo "Messages after expunge: " . $check->Nmsgs . "<br />\n"; + imap_close($mbox); ?> ]]> </programlisting> </example> </para> + <para> + See also: <function>imap_undelete</function>, + <function>imap_expunge</function>, and + <function>imap_close</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-deletemailbox.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-deletemailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.3 phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-deletemailbox.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-deletemailbox"> <refnamediv> @@ -19,7 +19,7 @@ of <parameter>mbox</parameter> names). </para> <para> - Returns &true; on success and &false; on error. + &return.success;. </para> <para> See also <function>imap_createmailbox</function>, http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-errors.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/imap/functions/imap-errors.xml diff -u phpdoc/en/reference/imap/functions/imap-errors.xml:1.2 phpdoc/en/reference/imap/functions/imap-errors.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-errors.xml:1.2 Wed Apr 17 02:39:17 2002 +++ phpdoc/en/reference/imap/functions/imap-errors.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-errors"> <refnamediv> @@ -23,6 +23,9 @@ <function>imap_errors</function> is called, the error stack is subsequently cleared. </para> + <para> + See also: <function>imap_last_error</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-fetchbody.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-fetchbody.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.3 phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-fetchbody.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-fetchbody"> <refnamediv> @@ -25,23 +25,25 @@ IMAP4 specification. Body parts are not decoded by this function. </para> <para> - The options for <function>imap_fetchbody</function> is a bitmask - with one or more of the following: + The <parameter>options</parameter> for + <function>imap_fetchbody</function> is a bitmask with one or more + of the following: <itemizedlist> <listitem> <simpara> - FT_UID - The <parameter>msg_number</parameter> is a UID + <constant>FT_UID</constant> - The <parameter>msg_number</parameter> is a UID </simpara> </listitem> <listitem> <simpara> - FT_PEEK - Do not set the \Seen flag if not already set + <constant>FT_PEEK</constant> - Do not set the \Seen flag if + not already set </simpara> </listitem> <listitem> <simpara> - FT_INTERNAL - The return string is in "internal" format, - without any attempt to canonicalize CRLF. + <constant>FT_INTERNAL</constant> - The return string is in + internal format, will not canonicalize to CRLF. </simpara> </listitem> </itemizedlist> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-fetchheader.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-fetchheader.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.5 phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.5 Tue Feb 17 16:57:01 2004 +++ phpdoc/en/reference/imap/functions/imap-fetchheader.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-fetchheader"> <refnamediv> @@ -21,20 +21,30 @@ returns that text string. </para> <para> - The options are: - <informalexample> - <literallayout> -FT_UID The msgno argument is a UID -FT_INTERNAL The return string is in "internal" format, - without any attempt to canonicalize to CRLF - newlines -FT_PREFETCHTEXT 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) - </literallayout> - </informalexample> + 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> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-getacl.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/imap/functions/imap-getacl.xml diff -u phpdoc/en/reference/imap/functions/imap-getacl.xml:1.1 phpdoc/en/reference/imap/functions/imap-getacl.xml:1.2 --- phpdoc/en/reference/imap/functions/imap-getacl.xml:1.1 Sun Nov 2 13:00:47 2003 +++ phpdoc/en/reference/imap/functions/imap-getacl.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.imap-getacl"> <refnamediv> <refname>imap_getacl</refname> @@ -17,6 +17,9 @@ &warn.undocumented.func; + <para> + See also: <function>imap_setacl</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-getmailboxes.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-getmailboxes.xml diff -u phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.5 phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.5 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-getmailboxes.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-getmailboxes"> <refnamediv> @@ -28,25 +28,26 @@ <itemizedlist> <listitem> <simpara> - LATT_NOINFERIORS - This mailbox has no "children" (there are - no mailboxes below this one). + <constant>LATT_NOINFERIORS</constant> - This mailbox has no + "children" (there are no mailboxes below this one). </simpara> </listitem> <listitem> <simpara> - LATT_NOSELECT - This is only a container, not a mailbox - you - cannot open it. + <constant>LATT_NOSELECT</constant> - This is only a container, + not a mailbox - you cannot open it. </simpara> </listitem> <listitem> <simpara> - LATT_MARKED - This mailbox is marked. Only used by UW-IMAPD. + <constant>LATT_MARKED</constant> - This mailbox is marked. + Only used by UW-IMAPD. </simpara> </listitem> <listitem> <simpara> - LATT_UNMARKED - This mailbox is not marked. Only used by - UW-IMAPD. + <constant>LATT_UNMARKED</constant> - This mailbox is not marked. + Only used by UW-IMAPD. </simpara> </listitem> </itemizedlist> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-last-error.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/imap/functions/imap-last-error.xml diff -u phpdoc/en/reference/imap/functions/imap-last-error.xml:1.2 phpdoc/en/reference/imap/functions/imap-last-error.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-last-error.xml:1.2 Wed Apr 17 02:39:19 2002 +++ phpdoc/en/reference/imap/functions/imap-last-error.xml Mon Mar 8 04:18:41 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-last-error"> <refnamediv> @@ -22,6 +22,9 @@ subsequently, with no intervening errors, will return the same error. </para> + <para> + See also: <function>imap_errors</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-list.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-list.xml diff -u phpdoc/en/reference/imap/functions/imap-list.xml:1.3 phpdoc/en/reference/imap/functions/imap-list.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-list.xml:1.3 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-list.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.imap-list"> <refnamediv> <refname>imap_list</refname> @@ -30,8 +30,9 @@ $list = imap_list($mbox, "{your.imap.host}", "*"); if (is_array($list)) { reset($list); - while (list($key, $val) = each($list)) + while (list($key, $val) = each($list)) { echo imap_utf7_decode($val) . "<br />\n"; + } } else { echo "imap_list failed: " . imap_last_error() . "\n"; } @@ -42,6 +43,9 @@ </programlisting> </example> </para> + <para> + See also: <function>imap_getmailboxes</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-listscan.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/imap/functions/imap-listscan.xml diff -u phpdoc/en/reference/imap/functions/imap-listscan.xml:1.1 phpdoc/en/reference/imap/functions/imap-listscan.xml:1.2 --- phpdoc/en/reference/imap/functions/imap-listscan.xml:1.1 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-listscan.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.imap-listscan"> <refnamediv> <refname>imap_listscan</refname> @@ -20,9 +20,13 @@ <para> Returns an array containing the names of the mailboxes that have <parameter>content</parameter> in the text of the mailbox. + </para> + <para> This function is similar to <function>imap_listmailbox</function>, but it will additionally check for the presence of the string <parameter>content</parameter> inside the mailbox data. + </para> + <para> See <function>imap_getmailboxes</function> for a description of <parameter>ref</parameter> and <parameter>pattern</parameter>. </para> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-mail-compose.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-mail-compose.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.5 phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.5 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-mail-compose.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-mail-compose"> <refnamediv> @@ -24,32 +24,32 @@ <![CDATA[ <?php -$envelope["from"]="joe@example.com"; -$envelope["to"]="foo@example.com"; -$envelope["cc"]="bar@example.com"; - -$part1["type"]=TYPEMULTIPART; -$part1["subtype"]="mixed"; - -$filename="/tmp/imap.c.gz"; -$fp=fopen($filename, "r"); -$contents=fread($fp, filesize($filename)); +$envelope["from"]= "joe@example.com"; +$envelope["to"] = "foo@example.com"; +$envelope["cc"] = "bar@example.com"; + +$part1["type"] = TYPEMULTIPART; +$part1["subtype"] = "mixed"; + +$filename = "/tmp/imap.c.gz"; +$fp = fopen($filename, "r"); +$contents = fread($fp, filesize($filename)); fclose($fp); -$part2["type"]=TYPEAPPLICATION; -$part2["encoding"]=ENCBINARY; -$part2["subtype"]="octet-stream"; -$part2["description"]=basename($filename); -$part2["contents.data"]=$contents; - -$part3["type"]=TYPETEXT; -$part3["subtype"]="plain"; -$part3["description"]="description3"; -$part3["contents.data"]="contents.data3\n\n\n\t"; - -$body[1]=$part1; -$body[2]=$part2; -$body[3]=$part3; +$part2["type"] = TYPEAPPLICATION; +$part2["encoding"] = ENCBINARY; +$part2["subtype"] = "octet-stream"; +$part2["description"] = basename($filename); +$part2["contents.data"] = $contents; + +$part3["type"] = TYPETEXT; +$part3["subtype"] = "plain"; +$part3["description"] = "description3"; +$part3["contents.data"] = "contents.data3\n\n\n\t"; + +$body[1] = $part1; +$body[2] = $part2; +$body[3] = $part3; echo nl2br(imap_mail_compose($envelope, $body)); http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-mail-copy.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-mail-copy.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.4 phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.4 Wed May 7 17:31:30 2003 +++ phpdoc/en/reference/imap/functions/imap-mail-copy.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-mail-copy"> <refnamediv> @@ -15,31 +15,33 @@ <methodparam><type>string</type><parameter>mbox</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> </methodsynopsis> - <para> - Returns &true; on success and &false; on error. - </para> <para> Copies mail messages specified by <parameter>msglist</parameter> - to specified mailbox. <parameter>msglist</parameter> is a range - not just message numbers (as described in - <ulink url="&url.rfc;2060">RFC2060</ulink>). + to specified mailbox. &return.success;. + </para> + <para> + <parameter>msglist</parameter> is a range not just message + numbers (as described in <ulink url="&url.rfc;2060">RFC2060</ulink>). </para> <para> - Flags is a bitmask of one or more of + <parameter>options</parameter> is a bitmask of one or more of <itemizedlist> <listitem> <simpara> - CP_UID - the sequence numbers contain UIDS + <constant>CP_UID</constant> - the sequence numbers contain UIDS </simpara> </listitem> <listitem> <simpara> - CP_MOVE - Delete the messages from the current mailbox after - copying + <constant>CP_MOVE</constant> - Delete the messages from + the current mailbox after copying </simpara> </listitem> </itemizedlist> </para> + <para> + See also <function>imap_mail_move</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-mail-move.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-mail-move.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.5 phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.5 Wed May 7 17:31:30 2003 +++ phpdoc/en/reference/imap/functions/imap-mail-move.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-mail-move"> <refnamediv> @@ -17,23 +17,25 @@ </methodsynopsis> <para> Moves mail messages specified by <parameter>msglist</parameter> - to specified mailbox <parameter>mbox</parameter>. <parameter>msglist</parameter> - is a range not just message numbers (as described in - <ulink url="&url.rfc;2060">RFC2060</ulink>). + to specified mailbox <parameter>mbox</parameter>. &return.success;. </para> <para> - &return.success; + <parameter>msglist</parameter> is a range not just message numbers + (as described in <ulink url="&url.rfc;2060">RFC2060</ulink>). </para> <para> - <parameter>options</parameter> is a bitmask and may contain the single option + <parameter>options</parameter> is a bitmask and may contain the single option: <itemizedlist> <listitem> <simpara> - CP_UID - the sequence numbers contain UIDS + <constant>CP_UID</constant> - the sequence numbers contain UIDS </simpara> </listitem> </itemizedlist> </para> + <para> + See also <function>imap_mail_copy</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-mail.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-mail.xml diff -u phpdoc/en/reference/imap/functions/imap-mail.xml:1.4 phpdoc/en/reference/imap/functions/imap-mail.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-mail.xml:1.4 Sat Dec 20 20:22:51 2003 +++ phpdoc/en/reference/imap/functions/imap-mail.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-mail"> <refnamediv> @@ -21,11 +21,21 @@ <methodparam choice="opt"><type>string</type><parameter>rpath</parameter></methodparam> </methodsynopsis> <para> - This function allows sending of emails with correct handling of Cc and Bcc receivers. - The parameters to, cc and bcc are all strings and are all parsed as rfc822 address lists. - The receivers specified in bcc will get the mail, but are excluded from the headers. - Use the rpath parameter to specify return path. This is useful when using PHP as a mail client - for multiple users. + This function allows sending of emails with correct handling of + Cc and Bcc receivers. &return.success;. + </para> + <para> + The parameters <parameter>to</parameter>, <parameter>cc</parameter> + and <parameter>bcc</parameter> are all strings and are all parsed + as rfc822 address lists. + </para> + <para> + The receivers specified in <parameter>bcc</parameter> will get the + mail, but are excluded from the headers. + </para> + <para> + Use the <parameter>rpath</parameter> parameter to specify return path. + This is useful when using PHP as a mail client for multiple users. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml?r1=1.6&r2=1.7&ty=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.6 phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml:1.6 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> <refentry id="function.imap-mime-header-decode"> <refnamediv> @@ -17,7 +17,7 @@ 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" & "text". + where each object has two properties, "charset" and "text". 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". http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-msgno.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-msgno.xml diff -u phpdoc/en/reference/imap/functions/imap-msgno.xml:1.3 phpdoc/en/reference/imap/functions/imap-msgno.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-msgno.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-msgno.xml Mon Mar 8 04:18:42 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-msgno"> <refnamediv> @@ -18,7 +18,11 @@ </methodsynopsis> <para> This function returns the message sequence number for the given - UID. It is the inverse of <function>imap_uid</function>. + <parameter>uid</parameter>. It is the inverse of + <function>imap_uid</function>. + </para> + <para> + See also <function>imap_uid</function>. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-open.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/imap/functions/imap-open.xml diff -u phpdoc/en/reference/imap/functions/imap-open.xml:1.6 phpdoc/en/reference/imap/functions/imap-open.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-open.xml:1.6 Wed Dec 17 09:32:31 2003 +++ phpdoc/en/reference/imap/functions/imap-open.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-open"> <refnamediv> @@ -33,28 +33,30 @@ with <function>imap_utf7_encode</function>. </para> <para> - The options are a bit mask with one or more of the following: + The <parameter>options</parameter> are a bit mask with one or more of the following: <itemizedlist> <listitem> <simpara> - OP_READONLY - Open mailbox read-only + <constant>OP_READONLY</constant> - Open mailbox read-only </simpara> </listitem> <listitem> <simpara> - OP_ANONYMOUS - Don't use or update a + <constant>OP_ANONYMOUS</constant> - Don't use or update a <filename>.newsrc</filename> for news (NNTP only) </simpara> </listitem> <listitem> <simpara> - OP_HALFOPEN - For IMAP and NNTP names, open a connection but - don't open a mailbox + <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but + don't open a mailbox. </simpara> - </listitem> + </listitem> <listitem> <simpara> - CL_EXPUNGE - Expunge mailbox automatically upon mailbox close + <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close + (see also <function>imap_delete</function> and + <function>imap_expunge</function>) </simpara> </listitem> </itemizedlist> @@ -124,7 +126,7 @@ <?php $mbox = imap_open("{your.imap.host:143}", "username", "password"); -echo "<p><h1>Mailboxes</h1>\n"; +echo "<h1>Mailboxes</h1>\n"; $folders = imap_listmailbox($mbox, "{your.imap.host:143}", "*"); if ($folders == false) { @@ -135,7 +137,7 @@ } } -echo "<p><h1>Headers in INBOX</h1>\n"; +echo "<h1>Headers in INBOX</h1>\n"; $headers = imap_headers($mbox); if ($headers == false) { http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-qprint.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-qprint.xml diff -u phpdoc/en/reference/imap/functions/imap-qprint.xml:1.3 phpdoc/en/reference/imap/functions/imap-qprint.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-qprint.xml:1.3 Wed May 7 17:31:30 2003 +++ phpdoc/en/reference/imap/functions/imap-qprint.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-qprint"> <refnamediv> @@ -19,9 +19,6 @@ 6.7). </para> <para> - Returns an 8 bit (binary) string. - </para> - <para> See also <function>imap_8bit</function>. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-reopen.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-reopen.xml diff -u phpdoc/en/reference/imap/functions/imap-reopen.xml:1.5 phpdoc/en/reference/imap/functions/imap-reopen.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-reopen.xml:1.5 Wed Dec 17 09:32:31 2003 +++ phpdoc/en/reference/imap/functions/imap-reopen.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-reopen"> <refnamediv> @@ -15,32 +15,32 @@ <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function reopens the specified stream to a new mailbox on - an IMAP or NNTP server. + This function reopens the specified stream to a new + <parameter>mailbox</parameter> on an IMAP or NNTP server. </para> <para> - The options are a bit mask with one or more of the following: + The <parameter>options</parameter> are a bit mask with one or more of the following: <itemizedlist> <listitem> <simpara> - OP_READONLY - Open mailbox read-only + <constant>OP_READONLY</constant> - Open mailbox read-only </simpara> </listitem> <listitem> <simpara> - OP_ANONYMOUS - Don't use or update a + <constant>OP_ANONYMOUS</constant> - Don't use or update a <filename>.newsrc</filename> for news (NNTP only) </simpara> </listitem> <listitem> <simpara> - OP_HALFOPEN - For IMAP and NNTP names, open a connection but + <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but don't open a mailbox. </simpara> </listitem> <listitem> <simpara> - CL_EXPUNGE - Expunge mailbox automatically upon mailbox close + <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close (see also <function>imap_delete</function> and <function>imap_expunge</function>) </simpara> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml?r1=1.7&r2=1.8&ty=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.7 phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml:1.7 Mon Dec 15 11:51:13 2003 +++ phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-rfc822-parse-adrlist"> <refnamediv> @@ -49,9 +49,12 @@ <programlisting role="php"> <![CDATA[ <?php + $address_string = "Joe Doe <doe@example.com>, postmaster@example.com, root"; $address_array = imap_rfc822_parse_adrlist($address_string, "example.com"); -if (!is_array($address_array) || count($address_array) < 1) die("something is wrong\n"); +if (!is_array($address_array) || count($address_array) < 1) { + die("something is wrong\n"); +} foreach ($address_array as $val) { echo "mailbox : " . $val->mailbox . "<br />\n"; http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml?r1=1.6&r2=1.7&ty=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.6 phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml:1.6 Thu Dec 18 12:44:50 2003 +++ phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-rfc822-write-address"> <refnamediv> @@ -20,7 +20,8 @@ <para> Returns a properly formatted email address as defined in <ulink url="&url.rfc;2822">RFC2822</ulink> - given the mailbox, host, and personal info. + given the <parameter>mailbox</parameter>, <parameter>host</parameter>, + and <parameter>personal</parameter> info. </para> <para> <example> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-setacl.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-setacl.xml diff -u phpdoc/en/reference/imap/functions/imap-setacl.xml:1.3 phpdoc/en/reference/imap/functions/imap-setacl.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-setacl.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-setacl.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 --> <refentry id='function.imap-setacl'> <refnamediv> @@ -20,6 +20,9 @@ <para> &warn.undocumented.func; </para> + <para> + See also: <function>imap_getacl</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-setflag-full.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/imap/functions/imap-setflag-full.xml diff -u phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.7 phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.7 Thu Dec 18 12:44:50 2003 +++ phpdoc/en/reference/imap/functions/imap-setflag-full.xml Mon Mar 8 04:18:43 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-setflag-full"> <refnamediv> @@ -16,8 +16,9 @@ <methodparam><type>string</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - This function causes a store to add the specified flag to the - flags set for the messages in the specified sequence. + 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>. </para> <para> The flags which you can set are "\\Seen", "\\Answered", @@ -25,13 +26,16 @@ by RFC2060). </para> <para> - The options are a bit mask with one or more of the following: - <informalexample> - <literallayout> -ST_UID The sequence argument contains UIDs instead of - sequence numbers - </literallayout> - </informalexample> + <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> <para> <example> @@ -52,7 +56,10 @@ ]]> </programlisting> </example> - </para> + </para> + <para> + See also: <function>imap_clearflag_full</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-sort.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-sort.xml diff -u phpdoc/en/reference/imap/functions/imap-sort.xml:1.3 phpdoc/en/reference/imap/functions/imap-sort.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-sort.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-sort.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-sort"> <refnamediv> @@ -25,26 +25,58 @@ </para> <para> Criteria can be one (and only one) of the following: - <informalexample> - <literallayout> -SORTDATE message Date -SORTARRIVAL arrival date -SORTFROM mailbox in first From address -SORTSUBJECT message Subject -SORTTO mailbox in first To address -SORTCC mailbox in first cc address -SORTSIZE size of message in octets - </literallayout> - </informalexample> + <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> <para> The flags are a bitmask of one or more of the following: - <informalexample> - <literallayout> -SE_UID Return UIDs instead of sequence numbers -SE_NOPREFETCH Don't prefetch searched messages. - </literallayout> - </informalexample> + <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> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-status.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/imap/functions/imap-status.xml diff -u phpdoc/en/reference/imap/functions/imap-status.xml:1.7 phpdoc/en/reference/imap/functions/imap-status.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-status.xml:1.7 Thu Dec 18 12:44:50 2003 +++ phpdoc/en/reference/imap/functions/imap-status.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> <refentry id="function.imap-status"> <refnamediv> @@ -78,9 +78,10 @@ echo "Unseen: " . $status->unseen . "<br />\n"; echo "UIDnext: " . $status->uidnext . "<br />\n"; echo "UIDvalidity:" . $status->uidvalidity . "<br />\n"; -} else +} else { echo "imap_status failed: " . imap_last_error() . "\n"; - +} + imap_close($mbox); ?> ]]> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-subscribe.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-subscribe.xml diff -u phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.4 phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.4 Wed Feb 5 22:32:42 2003 +++ phpdoc/en/reference/imap/functions/imap-subscribe.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.7 --> <refentry id="function.imap-subscribe"> <refnamediv> @@ -19,6 +19,9 @@ <para> &return.success; </para> + <para> + See also: <function>imap_unsubscribe</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-uid.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/imap/functions/imap-uid.xml diff -u phpdoc/en/reference/imap/functions/imap-uid.xml:1.3 phpdoc/en/reference/imap/functions/imap-uid.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-uid.xml:1.3 Wed Oct 9 10:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-uid.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-uid"> <refnamediv> @@ -28,6 +28,9 @@ This is not supported by POP3 mailboxes. </para> </note> + <para> + See also: <function>imap_msgno</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-undelete.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-undelete.xml diff -u phpdoc/en/reference/imap/functions/imap-undelete.xml:1.4 phpdoc/en/reference/imap/functions/imap-undelete.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-undelete.xml:1.4 Wed Feb 5 22:32:42 2003 +++ phpdoc/en/reference/imap/functions/imap-undelete.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-undelete"> <refnamediv> @@ -23,6 +23,11 @@ <para> &return.success; </para> + <para> + See also: + <function>imap_delete</function>, and + <function>imap_mail_move</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-unsubscribe.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/imap/functions/imap-unsubscribe.xml diff -u phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.4 phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.4 Wed Feb 5 22:32:42 2003 +++ phpdoc/en/reference/imap/functions/imap-unsubscribe.xml Mon Mar 8 04:18:44 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-unsubscribe"> <refnamediv> @@ -19,6 +19,9 @@ <para> &return.success; </para> + <para> + See also: <function>imap_subscribe</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-utf7-decode.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/imap/functions/imap-utf7-decode.xml diff -u phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.5 phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.5 Wed Dec 17 09:32:31 2003 +++ phpdoc/en/reference/imap/functions/imap-utf7-decode.xml Mon Mar 8 04:18:45 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.16 --> <refentry id="function.imap-utf7-decode"> <refnamediv> @@ -23,13 +23,20 @@ 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> + <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 + <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>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-utf7-encode.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/imap/functions/imap-utf7-encode.xml diff -u phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.6 phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.6 Wed Dec 17 09:32:31 2003 +++ phpdoc/en/reference/imap/functions/imap-utf7-encode.xml Mon Mar 8 04:18:45 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> <refentry id="function.imap-utf7-encode"> <refnamediv> @@ -16,16 +16,21 @@ </methodsynopsis> <para> Converts <parameter>data</parameter> to modified UTF-7 - text. This is needed to encode mailbox names that contain certain + text. Note that <parameter>data</parameter> is expected to be + encoded in ISO-8859-1. + </para> + <para> + This is needed to encode mailbox names that contain certain characters which are not in range of printable ASCII characters. - Note that <parameter>data</parameter> is expected to be - encoded in ISO-8859-1. The modified UTF-7 encoding is defined in <ulink + </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> - Returns the modified UTF-7 text. + See also: <function>imap_utf7_decode</function>. </para> </refsect1> </refentry>