CVS update: php3/doc/functions

Date: Wednesday December 9, 1998 @ 19:02 Author: jim Update of /repository/php3/doc/functions In directory asf:/u/temp/cvs-serv10785/functions Modified Files: imap.sgml Log Message: Some general cleanup and updates from user errata. Index: php3/doc/functions/imap.sgml diff -c php3/doc/functions/imap.sgml:1.21 php3/doc/functions/imap.sgml:1.22 *** php3/doc/functions/imap.sgml:1.21 Fri Nov 13 09:07:27 1998 --- php3/doc/functions/imap.sgml Wed Dec 9 19:02:16 1998 *************** *** 4,17 **** <partintro> <simpara> ! To get these functions to work, you have to compile ! PHP with --with-imap. That requires the c-client library ! to be installed. Grab it from ! ftp://ftp.cac.washington.edu/imap/imap-4.2.tar.Z and compile it. ! Then copy c-client/c-client.a to /usr/local/lib or some ! other directory on your link path and copy c-client/rfc822.h, ! mail.h and linkage.h to /usr/local/include or some ! other directory in your include path. </partintro> <refentry id="function.imap-append"> --- 4,15 ---- <partintro> <simpara> ! To get these functions to work, you have to compile PHP with --with-imap. That ! requires the c-client library to be installed. Grab the latest version from <ulink ! url="ftp://ftp.cac.washington.edu/imap/">ftp://ftp.cac.washington.edu/imap/</ulink> ! and compile it. Then copy c-client/c-client.a to /usr/local/lib or some other ! directory on your link path and copy c-client/rfc822.h, mail.h and linkage.h to ! /usr/local/include or some other directory in your include path. </partintro> <refentry id="function.imap-append"> *************** *** 29,43 **** <paramdef>string<parameter>flags</parameter></paramdef> </funcsynopsis> <para> ! Returns true on sucess, false on error. <para> ! imap_append() function appends a string message to the specified ! mailbox <parameter>mbox</parameter>. ! If the optional flags is specified, writes the <parameter>flags</parameter> to that mailbox also. </refsect1> </refentry> - <refentry id="function.imap-base64"> <refnamediv> <refname>imap_base64</refname> --- 27,43 ---- <paramdef>string<parameter>flags</parameter></paramdef> </funcsynopsis> <para> ! Returns true on sucess, false on error. <para> ! <function>imap_append</function> appends a string message to the specified ! mailbox <parameter>mbox</parameter>. If the optional <parameter>flags</parameter> ! is specified, writes the <parameter>flags</parameter> to that mailbox also. ! <para> ! When talking to the Cyrus IMAP server, you must use "\r\n" as your end-of-line ! terminator instead of "\n" or the operation will fail. </refsect1> </refentry> <refentry id="function.imap-base64"> <refnamediv> <refname>imap_base64</refname> *************** *** 50,57 **** <paramdef>string <parameter>text</parameter></paramdef> </funcsynopsis> <para> ! imap_base64() function decodes a BASE64 encoded text. The decoded ! message is returned as a string. </refsect1> </refentry> --- 50,57 ---- <paramdef>string <parameter>text</parameter></paramdef> </funcsynopsis> <para> ! <function>imap_base64</function> function decodes BASE-64 encoded text. The ! decoded message is returned as a string. </refsect1> </refentry> *************** *** 70,78 **** <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <para> ! imap_body() returns the body of the message, numbered <parameter> ! msg_number</parameter> in the current mailbox. ! The optional <parameter>flags</parameter> are a bit mask with one or more of the following: <itemizedlist> <listitem><simpara> FT_UID - The msgno is a UID --- 70,78 ---- <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <para> ! <function>imap_body</function> returns the body of the message, numbered ! <parameter> msg_number</parameter> in the current mailbox. The optional ! <parameter>flags</parameter> are a bit mask with one or more of the following: <itemizedlist> <listitem><simpara> FT_UID - The msgno is a UID *************** *** 100,106 **** <para> Returns information about the current mailbox. Returns FALSE on failure. <para> ! The imap_check() function checks the current mailbox status on the server and returns the information in an object with following properties. <para> <informalexample> --- 100,106 ---- <para> Returns information about the current mailbox. Returns FALSE on failure. <para> ! The <function>imap_check</function> function checks the current mailbox status on the server and returns the information in an object with following properties. <para> <informalexample> *************** *** 130,141 **** <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <para> ! Close the imap stream. Takes an optional <parameter>flag</parameter> CL_EXPUNGE, which ! will silently expunge the mailbox before closing. </refsect1> </refentry> - <refentry id="function.imap-createmailbox"> <refnamediv> <refname>imap_createmailbox</refname> --- 130,140 ---- <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <para> ! Close the imap stream. Takes an optional <parameter>flag</parameter> CL_EXPUNGE, ! which will silently expunge the mailbox before closing. </refsect1> </refentry> <refentry id="function.imap-createmailbox"> <refnamediv> <refname>imap_createmailbox</refname> *************** *** 148,157 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> - <para> - Returns true on success and false on error. <para> ! imap_createmailbox() creates a new mailbox specified by mbox. </refsect1> </refentry> --- 147,156 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> ! <function>imap_createmailbox</function> creates a new mailbox specified by <parameter>mbox</parameter>. ! <para> ! Returns true on success and false on error. </refsect1> </refentry> *************** *** 171,179 **** <para> Returns true. <para> ! imap_delete() function marks message pointed by msg_number for ! deletion. Actual deletion of the messages is done by <function> ! imap_expunge </function>. </refsect1> </refentry> --- 170,178 ---- <para> Returns true. <para> ! <function>imap_delete</function> function marks message pointed by ! <parameter>msg_number</parameter> for deletion. Actual deletion of the messages is ! done by <function>imap_expunge</function>. </refsect1> </refentry> *************** *** 190,199 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> - <para> - Returns true on success and false on error. <para> ! imap_deletemailbox() deletes the specified mailbox. </refsect1> </refentry> --- 189,198 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> ! <function>imap_deletemailbox</function> deletes the specified mailbox. ! <para> ! Returns true on success and false on error. </refsect1> </refentry> *************** *** 209,219 **** <funcdef>int <function>imap_expunge</function></funcdef> <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> - <para> - Returns true. <para> ! imap_expunge() deletes all the messages marked for deletion by ! <function>imap_delete</function>. </refsect1> </refentry> --- 208,218 ---- <funcdef>int <function>imap_expunge</function></funcdef> <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> ! <function>imap_expunge</function> deletes all the messages marked for deletion by ! <function>imap_delete</function>. ! <para> ! Returns true. </refsect1> </refentry> *************** *** 239,245 **** index into a body part list as per the IMAP4 specification. Body parts are not decoded by this function. <para> ! The options for imap_fetchbody are a bitmask with one or more of the following <itemizedlist> <listitem><simpara> FT_UID - The msgono is a UID --- 238,244 ---- index into a body part list as per the IMAP4 specification. Body parts are not decoded by this function. <para> ! The options for <function>imap_fetchbody </function>e a bitmask with one or more of the following <itemizedlist> <listitem><simpara> FT_UID - The msgono is a UID *************** *** 264,288 **** <funcdef>array <function>imap_fetchstructure</function></funcdef> <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>int <parameter>msg_number</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <para> ! This function causes a fetch of all the structured information for the ! given msg_number. The returned value is an object with following ! elements. ! <para> ! <informalexample><literallayout> ! type, encoding, ifsubtype, subtype, ifdescription, description, ifid, ! id, lines, bytes, ifparameters ! </literallayout></informalexample> <para> ! It also returns an array of objects called parameters[]. This object ! has following properties. <informalexample><literallayout> attribute, value ! </literallayout></informalexample> ! In case of multipart, it also returns an array of objects of all the ! properties, called parts[]. </refsect1> </refentry> --- 263,286 ---- <funcdef>array <function>imap_fetchstructure</function></funcdef> <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>int <parameter>msg_number</parameter></paramdef> </funcsynopsis> <para> ! This function causes a fetch of all the structured information for the given ! <parameter>msg_number</parameter>. The returned value is an object with following ! elements. ! <para> ! <informalexample><literallayout> ! type, encoding, ifsubtype, subtype, ifdescription, description, ifid, ! id, lines, bytes, ifparameters ! </literallayout></informalexample> <para> ! It also returns an array of objects called parameters[]. This object ! has following properties. <informalexample><literallayout> attribute, value ! </literallayout></informalexample> ! In case of multipart, it also returns an array of objects of all the ! properties, called parts[]. </refsect1> </refentry> *************** *** 418,426 **** <paramdef>string <parameter>pattern</parameter></paramdef> </funcsynopsis> <para> ! Returns an array of all the mailboxes that you have subscribed. ! The ref and pattern arguments specify the base location to search ! from and the pattern the mailbox name must match. </refsect1> </refentry> --- 416,424 ---- <paramdef>string <parameter>pattern</parameter></paramdef> </funcsynopsis> <para> ! Returns an array of all the mailboxes that you have subscribed. The ! <parameter>ref</parameter> and <parameter>pattern</parameter> arguments specify the ! base location to search from and the pattern the mailbox name must match. </refsect1> </refentry> *************** *** 442,449 **** <para> Returns true on success and false on error. <para> ! Copies mail messages specified by <parameter>msglist</parameter> to ! specified mailbox. msglist is a range not just message numbers. <para> flags is a bitmask of one or more of <itemizedlist> <listitem><simpara> --- 440,447 ---- <para> Returns true on success and false on error. <para> ! Copies mail messages specified by <parameter>msglist</parameter> to specified ! mailbox. <parameter>msglist</parameter> is a range not just message numbers. <para> flags is a bitmask of one or more of <itemizedlist> <listitem><simpara> *************** *** 469,479 **** <paramdef>string <parameter>msglist</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> - <para> - Returns true on success and false on error. <para> ! Moves mail messages specified by <parameter>msglist</parameter> to ! specified mailbox. msglist is a range not just message numbers. </refsect1> </refentry> --- 467,477 ---- <paramdef>string <parameter>msglist</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> ! Moves mail messages specified by <parameter>msglist</parameter> to specified ! mailbox. <parameter>msglist</parameter> is a range not just message numbers. ! <para> ! Returns true on success and false on error. </refsect1> </refentry> *************** *** 577,588 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> ! Returns true if the stream is still alive, false otherwise. <para> ! imap_ping() function pings the stream to see it is still active. It may ! discover new mail; this is the preferred method for a periodic "new ! mail check" as well as a "keep alive" for servers which have inactivity ! timeout. </refsect1> </refentry> --- 575,585 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> ! Returns true if the stream is still alive, false otherwise. <para> ! <function>imap_ping</function> function pings the stream to see it is still ! active. It may discover new mail; this is the preferred method for a periodic "new ! mail check" as well as a "keep alive" for servers which have inactivity timeout. </refsect1> </refentry> *************** *** 600,609 **** <paramdef>string <parameter>old_mbox</parameter></paramdef> <paramdef>string <parameter>new_mbox</parameter></paramdef> </funcsynopsis> - <para> - Returns true on success and false on error. <para> This function renames on old mailbox to new mailbox. </refsect1> </refentry> --- 597,606 ---- <paramdef>string <parameter>old_mbox</parameter></paramdef> <paramdef>string <parameter>new_mbox</parameter></paramdef> </funcsynopsis> <para> This function renames on old mailbox to new mailbox. + <para> + Returns true on success and false on error. </refsect1> </refentry> *************** *** 654,663 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> - <para> - Returns true on success and false on error. <para> Subscribe to a new mailbox. </refsect1> </refentry> --- 651,660 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> Subscribe to a new mailbox. + <para> + Returns true on success and false on error. </refsect1> </refentry> *************** *** 674,684 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>int <parameter>msg_number</parameter></paramdef> </funcsynopsis> - <para> - Returns true on success and false on error. <para> This function removes the deletion flag for a specified message, which is set by <function>imap_delete</function>. </refsect1> </refentry> --- 671,681 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>int <parameter>msg_number</parameter></paramdef> </funcsynopsis> <para> This function removes the deletion flag for a specified message, which is set by <function>imap_delete</function>. + <para> + Returns true on success and false on error. </refsect1> </refentry> *************** *** 695,704 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> - <para> - Returns true on success and false on error. <para> Unsubscribe from a specified mailbox. </refsect1> </refentry> --- 692,701 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> Unsubscribe from a specified mailbox. + <para> + Returns true on success and false on error. </refsect1> </refentry> *************** *** 713,722 **** <funcdef>string <function>imap_qprint</function></funcdef> <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> - <para> - Returns an 8 bit (binary) string <para> Convert a quoted-printable string to an 8 bit string </refsect1> </refentry> --- 710,719 ---- <funcdef>string <function>imap_qprint</function></funcdef> <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> Convert a quoted-printable string to an 8 bit string + <para> + Returns an 8 bit (binary) string </refsect1> </refentry> *************** *** 731,740 **** <funcdef>string <function>imap_8bit</function></funcdef> <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> - <para> - Returns a quoted-printable string <para> Convert an 8bit string to a quoted-printable string. </refsect1> </refentry> --- 728,737 ---- <funcdef>string <function>imap_8bit</function></funcdef> <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> Convert an 8bit string to a quoted-printable string. + <para> + Returns a quoted-printable string </refsect1> </refentry> *************** *** 749,758 **** <funcdef>string <function>imap_binary</function></funcdef> <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> - <para> - Returns a base64 string <para> Convert an 8bit string to a base64 string. </refsect1> </refentry> --- 746,755 ---- <funcdef>string <function>imap_binary</function></funcdef> <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> Convert an 8bit string to a base64 string. + <para> + Returns a base64 string </refsect1> </refentry> *************** *** 772,778 **** <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> ! Returns an array containing the names of the mailboxes that have that string in the text of the mailbox. </refsect1> </refentry> --- 769,776 ---- <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> ! Returns an array containing the names of the mailboxes that have ! <parameter>string</parameter> in the text of the mailbox. </refsect1> </refentry> *************** *** 781,787 **** <refentry id="function.imap-mailboxmsginfo"> <refnamediv> <refname>imap_mailboxmsginfo</refname> ! <refpurpose>Mailboxmsginfo current mailbox</refpurpose> </refnamediv> <refsect1> <title>Description</title> --- 779,785 ---- <refentry id="function.imap-mailboxmsginfo"> <refnamediv> <refname>imap_mailboxmsginfo</refname> ! <refpurpose>Get information about the current mailbox</refpurpose> </refnamediv> <refsect1> <title>Description</title> *************** *** 792,798 **** <para> Returns information about the current mailbox. Returns FALSE on failure. <para> ! The imap_mailboxmsginfo() function checks the current mailbox status on the server and returns the information in an object with following properties. <para> <informalexample> --- 790,796 ---- <para> Returns information about the current mailbox. Returns FALSE on failure. <para> ! The <function>imap_mailboxmsginfo</function> function checks the current mailbox status on the server and returns the information in an object with following properties. <para> <informalexample> *************** *** 824,830 **** <paramdef>string <parameter>personal</parameter></paramdef> </funcsynopsis> <para> ! Returns a properly formatted email address given the mailbox, host, and personal info. </refsect1> </refentry> --- 822,828 ---- <paramdef>string <parameter>personal</parameter></paramdef> </funcsynopsis> <para> ! Returns a properly formatted email address given the mailbox, host, and personal info. </refsect1> </refentry> *************** *** 843,852 **** --- 841,855 ---- <para> This function parses the address tring and for each address, returns an array of objects. The 4 objects are: + <para> + <informalexample> + <literallayout> mailbox - the mailbox name (username) host - the host name personal - the personal name adl - at domain source route + </literallayout> + </informalexample> </refsect1> </refentry> *************** *** 865,877 **** <paramdef>string <parameter>options</parameter></paramdef> </funcsynopsis> <para> ! This function causes a store to add the specified flag to the flags ! set for the messages in the specified sequence. ! <para> The options are a bit mask with one or more of the following: ST_UID The sequence argument contains UIDs instead of sequence numbers ! </para> </refsect1> </refentry> --- 868,883 ---- <paramdef>string <parameter>options</parameter></paramdef> </funcsynopsis> <para> ! This function causes a store to add the specified flag to the flags set for the ! messages in the specified sequence. ! <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> </refsect1> </refentry> *************** *** 891,901 **** </funcsynopsis> <para> This function causes a store to delete the specified flag to the flags set for the messages in the specified sequence. ! <para> The options are a bit mask with one or more of the following: ST_UID The sequence argument contains UIDs instead of sequence numbers ! </para> </refsect1> </refentry> --- 897,910 ---- </funcsynopsis> <para> This function causes a store to delete the specified flag to the flags set for the messages in the specified sequence. ! <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> </refsect1> </refentry> *************** *** 913,924 **** <paramdef>int <parameter>reverse</parameter></paramdef> <paramdef>int <parameter>options</parameter></paramdef> </funcsynopsis> <para> ! Returns an array of message numbers sorted by the given parameters ! <para> ! Rev is 1 for reverse-sorting. ! <para> ! Criteria can be one (and only one) of the following: SORTDATE message Date SORTARRIVAL arrival date SORTFROM mailbox in first From address --- 922,935 ---- <paramdef>int <parameter>reverse</parameter></paramdef> <paramdef>int <parameter>options</parameter></paramdef> </funcsynopsis> + <para> + Returns an array of message numbers sorted by the given parameters <para> ! Rev is 1 for reverse-sorting. ! <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 *************** *** 926,938 **** SORTTO mailbox in first To address SORTCC mailbox in first cc address SORTSIZE size of message in octets ! ! <para> ! The flags are a bitmask of one or more of the following: SE_UID Return UIDs instead of sequence numbers SE_NOPREFETCH Don't prefetch searched messages. ! ! </para> </refsect1> </refentry> --- 937,952 ---- SORTTO mailbox in first To address SORTCC mailbox in first cc address SORTSIZE size of message in octets ! </literallayout> ! </informalexample> ! <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> </refsect1> </refentry> *************** *** 952,961 **** </funcsynopsis> <para> This function causes a fetch of the complete, unfiltered RFC 822 ! format header of the specified message as a text string and returns ! that text string. ! <para> ! The options are: FT_UID The msgno argument is a UID FT_INTERNAL The return string is in "internal" format, without any attempt to canonicalize to CRLF --- 966,977 ---- </funcsynopsis> <para> This function causes a fetch of the complete, unfiltered RFC 822 ! format header of the specified message as a text string and returns ! that text string. ! <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 *************** *** 965,971 **** IMAP connection if a full message text is desired (e.g. in a "save to local file" operation) ! </refsect1> </refentry> --- 981,988 ---- IMAP connection if a full message text is desired (e.g. in a "save to local file" operation) ! </literallayout> ! </informalexample> </refsect1> </refentry> *************** *** 982,995 **** <paramdef>int <parameter>msgno</parameter></paramdef> </funcsynopsis> <para> ! This function returns the UID for the given message sequence number </refsect1> </refentry> - - </reference> - <!-- Keep this comment at the end of the file Local variables: --- 999,1009 ---- <paramdef>int <parameter>msgno</parameter></paramdef> </funcsynopsis> <para> ! This function returns the UID for the given message sequence number </refsect1> </refentry> </reference> <!-- Keep this comment at the end of the file Local variables: -- PHP Development Mailing List http://www.php.net/ To unsubscribe send an empty message to php-dev-unsubscribe@lists.php.net For help: php-dev-help@lists.php.net