CVS update: php3/doc/functions

Date: Saturday April 10, 1999 @ 8:04 Author: eschmid Update of /repository/php3/doc/functions In directory asf:/u/temp/cvs-serv4875 Modified Files: imap.sgml Log Message: Changed parameter for imap_num_msg (int stream_id) according the prototypes. Index: php3/doc/functions/imap.sgml diff -c php3/doc/functions/imap.sgml:1.24 php3/doc/functions/imap.sgml:1.25 *** php3/doc/functions/imap.sgml:1.24 Wed Jan 20 11:11:41 1999 --- php3/doc/functions/imap.sgml Sat Apr 10 08:04:14 1999 *************** *** 3,15 **** <titleabbrev>IMAP</titleabbrev> <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"> --- 3,17 ---- <titleabbrev>IMAP</titleabbrev> <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"> *************** *** 27,40 **** <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> --- 29,44 ---- <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> *************** *** 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> --- 54,61 ---- <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> ! <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 --- 74,83 ---- <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 *************** *** 98,117 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <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> ! <literallayout> ! Date : date of the message Driver : driver Mailbox : name of the mailbox Nmsgs : number of messages Recent : number of recent messages ! </literallayout> ! </informalexample> </refsect1> </refentry> --- 103,124 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <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> ! <literallayout> ! Date : date of the message Driver : driver Mailbox : name of the mailbox Nmsgs : number of messages Recent : number of recent messages ! </literallayout> ! </informalexample> </refsect1> </refentry> *************** *** 129,137 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> <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> --- 136,145 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> <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> *************** *** 148,154 **** <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> --- 156,163 ---- <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> *************** *** 168,178 **** <paramdef>int <parameter>msg_number</parameter></paramdef> </funcsynopsis> <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> --- 177,188 ---- <paramdef>int <parameter>msg_number</parameter></paramdef> </funcsynopsis> <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> *************** *** 189,196 **** <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> --- 199,207 ---- <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> *************** *** 209,216 **** <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> --- 220,227 ---- <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> *************** *** 220,226 **** <refentry id="function.imap-fetchbody"> <refnamediv> <refname>imap_fetchbody</refname> ! <refpurpose>Fetch a particular section of the body of the message</refpurpose> </refnamediv> <refsect1> <title>Description</title> --- 231,238 ---- <refentry id="function.imap-fetchbody"> <refnamediv> <refname>imap_fetchbody</refname> ! <refpurpose>Fetch a particular section of the body of the ! message</refpurpose> </refnamediv> <refsect1> <title>Description</title> *************** *** 231,244 **** <paramdef>string <parameter>part_number</parameter></paramdef> <paramdef>flags <parameter>flags</parameter></paramdef> </funcsynopsis> <para> ! This function causes a fetch of a particular section of the body of the ! specified messages as a text string and returns that text string. The ! section specification is a string of integers delimited by period which ! index into a body part list as per the IMAP4 specification. Body parts ! are not decoded by this function. ! <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 --- 243,257 ---- <paramdef>string <parameter>part_number</parameter></paramdef> <paramdef>flags <parameter>flags</parameter></paramdef> </funcsynopsis> + <para> + This function causes a fetch of a particular section of the body + of the specified messages as a text string and returns that text + string. The section specification is a string of integers + delimited by period which index into a body part list as per the + IMAP4 specification. Body parts are not decoded by this function. <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 *************** *** 265,286 **** <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> --- 278,305 ---- <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> *************** *** 301,309 **** <paramdef>int <parameter>defaulthost</parameter></paramdef> </funcsynopsis> <para> ! This function returns an object of various header elements <para> ! <informalexample><literallayout> remail,date,Date,subject,Subject,in_reply_to,message_id,newsgroups, followup_to,references toaddress (full to: line, up to 1024 characters) --- 320,329 ---- <paramdef>int <parameter>defaulthost</parameter></paramdef> </funcsynopsis> <para> ! This function returns an object of various header elements <para> ! <informalexample> ! <literallayout> remail,date,Date,subject,Subject,in_reply_to,message_id,newsgroups, followup_to,references toaddress (full to: line, up to 1024 characters) *************** *** 361,367 **** fetchfrom (from line formatted to fit <parameter>fromlength</parameter> characters) fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter> characters) ! </literallayout></informalexample> </refsect1> </refentry> --- 381,388 ---- fetchfrom (from line formatted to fit <parameter>fromlength</parameter> characters) fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter> characters) ! </literallayout> ! </informalexample> </refsect1> </refentry> *************** *** 377,384 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> ! Returns an array of string formatted with header info. One element per ! mail message. </refsect1> </refentry> --- 398,405 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> ! Returns an array of string formatted with header info. One ! element per mail message. </refsect1> </refentry> *************** *** 397,403 **** <paramdef>string <parameter>pat</parameter></paramdef> </funcsynopsis> <para> ! Returns an array containing the names of the mailboxes. </refsect1> </refentry> --- 418,424 ---- <paramdef>string <parameter>pat</parameter></paramdef> </funcsynopsis> <para> ! Returns an array containing the names of the mailboxes. </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> --- 437,447 ---- <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> *************** *** 438,448 **** <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <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> CP_UID - the sequence numbers contain UIDS --- 461,473 ---- <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <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> CP_UID - the sequence numbers contain UIDS *************** *** 467,475 **** <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> --- 492,501 ---- <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> *************** *** 479,494 **** <refentry id="function.imap-num-msg"> <refnamediv> <refname>imap_num_msg</refname> ! <refpurpose>Gives the number of messages in the current mailbox</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>int <function>imap_num_msg</function></funcdef> ! <void> </funcsynopsis> <para> ! Return the number of messages in the current mailbox. </refsect1> </refentry> --- 505,521 ---- <refentry id="function.imap-num-msg"> <refnamediv> <refname>imap_num_msg</refname> ! <refpurpose>Gives the number of messages in the current ! mailbox</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>int <function>imap_num_msg</function></funcdef> ! <paramdef>int <parameter>stream_id</parameter></paramdef> </funcsynopsis> <para> ! Return the number of messages in the current mailbox. </refsect1> </refentry> *************** *** 496,502 **** <refentry id="function.imap-num-recent"> <refnamediv> <refname>imap_num_recent</refname> ! <refpurpose>Gives the number of recent messages in current mailbox</refpurpose> </refnamediv> <refsect1> <title>Description</title> --- 523,530 ---- <refentry id="function.imap-num-recent"> <refnamediv> <refname>imap_num_recent</refname> ! <refpurpose>Gives the number of recent messages in current ! mailbox</refpurpose> </refnamediv> <refsect1> <title>Description</title> *************** *** 505,511 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> ! Returns the number of recent messages in the current mailbox. <para> </refsect1> </refentry> --- 533,539 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> ! Returns the number of recent messages in the current mailbox. <para> </refsect1> </refentry> *************** *** 529,548 **** Returns an IMAP stream on success and false on error. This function can also be used to open streams to POP3 and NNTP servers. To connect to an IMAP server running on port 143 on the ! local machine, do the following: ! <informalexample><programlisting role=php> $mbox = imap_open("{localhost:143}INBOX","user_id","password"); ! </programlisting></informalexample> To connect to a POP3 server on port 110 on the local server, use: ! <informalexample><programlisting> $mbox = imap_open("{localhost/pop3:110}INBOX","user_id","password"); ! </programlisting></informalexample> To connect to an NNTP server on port 119 on the local server, use: ! <informalexample><programlisting> $nntp = imap_open("{localhost/nntp:119}comp.test","",""); ! </programlisting></informalexample> To connect to a remote server replace "localhost" with the name or the IP address of the server you want to connect to. --- 557,584 ---- Returns an IMAP stream on success and false on error. This function can also be used to open streams to POP3 and NNTP servers. To connect to an IMAP server running on port 143 on the ! local machine, do the following: ! <informalexample> ! <programlisting role=php> $mbox = imap_open("{localhost:143}INBOX","user_id","password"); ! </programlisting> ! </informalexample> To connect to a POP3 server on port 110 on the local server, use: ! ! <informalexample> ! <programlisting> $mbox = imap_open("{localhost/pop3:110}INBOX","user_id","password"); ! </programlisting> ! </informalexample> To connect to an NNTP server on port 119 on the local server, use: ! ! <informalexample> ! <programlisting> $nntp = imap_open("{localhost/nntp:119}comp.test","",""); ! </programlisting> ! </informalexample> To connect to a remote server replace "localhost" with the name or the IP address of the server you want to connect to. *************** *** 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> --- 611,622 ---- <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> *************** *** 598,606 **** <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> --- 635,643 ---- <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> *************** *** 616,629 **** <funcdef>int <function>imap_reopen</function></funcdef> <paramdef>string <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mailbox</parameter></paramdef> ! <paramdef>string <parameter><optional>flags</optional></parameter></paramdef> </funcsynopsis> <para> ! Returns true on success and false on error. <para> ! This function reopens the specified stream to new mailbox. ! <para> ! the options are a bit mask with one or more of the following: <itemizedlist> <listitem><simpara> OP_READONLY - Open mailbox read-only --- 653,667 ---- <funcdef>int <function>imap_reopen</function></funcdef> <paramdef>string <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mailbox</parameter></paramdef> ! <paramdef>string ! <parameter><optional>flags</optional></parameter></paramdef> </funcsynopsis> <para> ! Returns true on success and false on error. <para> ! This function reopens the specified stream to new mailbox. ! <para> ! The options are a bit mask with one or more of the following: <itemizedlist> <listitem><simpara> OP_READONLY - Open mailbox read-only *************** *** 652,660 **** <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> ! Subscribe to a new mailbox. <para> ! Returns true on success and false on error. </refsect1> </refentry> --- 690,698 ---- <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> ! Subscribe to a new mailbox. <para> ! Returns true on success and false on error. </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> --- 709,719 ---- <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> *************** *** 693,708 **** <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> ! Unsubscribe from a specified mailbox. <para> ! Returns true on success and false on error. </refsect1> </refentry> <refentry id="function.imap-qprint"> <refnamediv> <refname>imap_qprint</refname> ! <refpurpose>Convert a quoted-printable string to an 8 bit string</refpurpose> </refnamediv> <refsect1> <title>Description</title> --- 731,747 ---- <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> ! Unsubscribe from a specified mailbox. <para> ! Returns true on success and false on error. </refsect1> </refentry> <refentry id="function.imap-qprint"> <refnamediv> <refname>imap_qprint</refname> ! <refpurpose>Convert a quoted-printable string to an 8 bit ! string</refpurpose> </refnamediv> <refsect1> <title>Description</title> *************** *** 711,719 **** <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> --- 750,758 ---- <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> *************** *** 729,737 **** <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> --- 768,776 ---- <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> *************** *** 747,765 **** <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> ! Convert an 8bit string to a base64 string. <para> Returns a base64 string </refsect1> </refentry> - - - <refentry id="function.imap-scanmailbox"> <refnamediv> <refname>imap_scanmailbox</refname> ! <refpurpose>Read the list of mailboxes, takes a string to search for in the text of the mailbox</refpurpose> </refnamediv> <refsect1> <title>Description</title> --- 786,802 ---- <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> ! Convert an 8bit string to a base64 string. <para> Returns a base64 string </refsect1> </refentry> <refentry id="function.imap-scanmailbox"> <refnamediv> <refname>imap_scanmailbox</refname> ! <refpurpose>Read the list of mailboxes, takes a string to search ! for in the text of the mailbox</refpurpose> </refnamediv> <refsect1> <title>Description</title> *************** *** 769,781 **** <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> - - <refentry id="function.imap-mailboxmsginfo"> <refnamediv> <refname>imap_mailboxmsginfo</refname> --- 806,816 ---- <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> <refentry id="function.imap-mailboxmsginfo"> <refnamediv> <refname>imap_mailboxmsginfo</refname> *************** *** 788,800 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <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> ! <literallayout> Date : date of the message Driver : driver Mailbox : name of the mailbox --- 823,836 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <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> ! <literallayout> Date : date of the message Driver : driver Mailbox : name of the mailbox *************** *** 802,809 **** Recent : number of recent messages Unread : number of unread messages Size : mailbox size ! </literallayout> ! </informalexample> </refsect1> </refentry> --- 838,845 ---- Recent : number of recent messages Unread : number of unread messages Size : mailbox size ! </literallayout> ! </informalexample> </refsect1> </refentry> *************** *** 811,817 **** <refentry id="function.imap-rfc822-write-address"> <refnamediv> <refname>imap_rfc822_write_address</refname> ! <refpurpose>Returns a properly formatted email address given the mailbox, host, and personal info.</refpurpose> </refnamediv> <refsect1> <title>Description</title> --- 847,854 ---- <refentry id="function.imap-rfc822-write-address"> <refnamediv> <refname>imap_rfc822_write_address</refname> ! <refpurpose>Returns a properly formatted email address given the ! mailbox, host, and personal info.</refpurpose> </refnamediv> <refsect1> <title>Description</title> *************** *** 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> --- 859,866 ---- <paramdef>string <parameter>personal</parameter></paramdef> </funcsynopsis> <para> ! Returns a properly formatted email address given the mailbox, ! host, and personal info. </refsect1> </refentry> *************** *** 839,855 **** <paramdef>string <parameter>default_host</parameter></paramdef> </funcsynopsis> <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> --- 877,893 ---- <paramdef>string <parameter>default_host</parameter></paramdef> </funcsynopsis> <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> *************** *** 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> --- 906,921 ---- <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> *************** *** 896,910 **** <paramdef>string <parameter>options</parameter></paramdef> </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> --- 934,949 ---- <paramdef>string <parameter>options</parameter></paramdef> </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> *************** *** 923,935 **** <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 --- 962,975 ---- <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 *************** *** 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> --- 977,992 ---- 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> *************** *** 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 --- 1006,1017 ---- </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 *************** *** 981,995 **** IMAP connection if a full message text is desired (e.g. in a "save to local file" operation) ! </literallayout> ! </informalexample> </refsect1> </refentry> <refentry id="function.imap-uid"> <refnamediv> <refname>imap_uid</refname> ! <refpurpose>This function returns the UID for the given message sequence number.</refpurpose> </refnamediv> <refsect1> <title>Description</title> --- 1021,1036 ---- IMAP connection if a full message text is desired (e.g. in a "save to local file" operation) ! </literallayout> ! </informalexample> </refsect1> </refentry> <refentry id="function.imap-uid"> <refnamediv> <refname>imap_uid</refname> ! <refpurpose>This function returns the UID for the given message ! sequence number.</refpurpose> </refnamediv> <refsect1> <title>Description</title> *************** *** 999,1005 **** <paramdef>int <parameter>msgno</parameter></paramdef> </funcsynopsis> <para> ! This function returns the UID for the given message sequence number </refsect1> </refentry> --- 1040,1047 ---- <paramdef>int <parameter>msgno</parameter></paramdef> </funcsynopsis> <para> ! This function returns the UID for the given message sequence ! number. </refsect1> </refentry> -- 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