CVS update: php3/doc/functions

Date: Friday August 21, 1998 @ 12:22 Author: musone Update of /repository/php3/doc/functions In directory asf:/tmp/cvs-serv27819 Modified Files: imap.sgml Log Message: we're getting there.. Index: php3/doc/functions/imap.sgml diff -c php3/doc/functions/imap.sgml:1.11 php3/doc/functions/imap.sgml:1.12 *** php3/doc/functions/imap.sgml:1.11 Thu Aug 20 23:54:30 1998 --- php3/doc/functions/imap.sgml Fri Aug 21 12:22:38 1998 *************** *** 14,25 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> <paramdef>string <parameter>message</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>. </refsect1> </refentry> --- 14,27 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> <paramdef>string <parameter>message</parameter></paramdef> + <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> *************** *** 37,47 **** </funcsynopsis> <para> imap_base64() function decodes a BASE64 encoded text. The decoded ! message is retunred as a string. ! <para> ! Note: This function uses built in c-client base64 decoding, not an ! internal routine, so one must load the imap.so library to use this ! function. </refsect1> </refentry> --- 39,45 ---- </funcsynopsis> <para> imap_base64() function decodes a BASE64 encoded text. The decoded ! message is returned as a string. </refsect1> </refentry> *************** *** 57,67 **** <funcdef>string <function>imap_body</function></funcdef> <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>int <parameter>msg_number</parameter></paramdef> </funcsynopsis> <para> imap_body() returns the body of the message, numbered <parameter> msg_number</parameter> in the current mailbox. ! <para> </refsect1> </refentry> --- 55,71 ---- <funcdef>string <function>imap_body</function></funcdef> <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>int <parameter>msg_number</parameter></paramdef> + <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>FT_UID - The msgno is a UID</listitem> ! <listitem>FT_PEEK - Do not set the \Seen flag if not already set</listitem> ! <listitem>FT_INTERNAL - The return string is in internal format, will not canonicalize to CRLF</listitem> ! </itemizedlist> </refsect1> </refentry> *************** *** 78,84 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> ! Returns information about the current mailbox. <para> The imap_check() function checks the current mailbox status on the server and returns the information in an object with following properties. --- 82,88 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <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. *************** *** 107,117 **** <funcsynopsis> <funcdef>int <function>imap_close</function></funcdef> <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> - <para> - Returns true on success and false on error. <para> ! Close the imap stream. </refsect1> </refentry> --- 111,121 ---- <funcsynopsis> <funcdef>int <function>imap_close</function></funcdef> <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> *************** *** 149,155 **** <paramdef>int <parameter>msg_number</parameter></paramdef> </funcsynopsis> <para> ! Returns true on success and false on error. <para> imap_delete() function marks message pointed by msg_number for deletion. Actual deletion of the messages is done by <function> --- 153,159 ---- <paramdef>int <parameter>msg_number</parameter></paramdef> </funcsynopsis> <para> ! Returns true. <para> imap_delete() function marks message pointed by msg_number for deletion. Actual deletion of the messages is done by <function> *************** *** 173,179 **** <para> Returns true on success and false on error. <para> ! imap_deletemailbox() deteles the specified mailbox. </refsect1> </refentry> --- 177,183 ---- <para> Returns true on success and false on error. <para> ! imap_deletemailbox() deletes the specified mailbox. </refsect1> </refentry> *************** *** 190,196 **** <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> ! Returns true on success and false on error. <para> imap_expunge() deletes all the messages marked for deletion by <function>imap_delete</function>. --- 194,200 ---- <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>. *************** *** 210,215 **** --- 214,220 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>int <parameter>msg_number</parameter></paramdef> <paramdef>int <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 *************** *** 217,222 **** --- 222,234 ---- 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 imap_fetchbody are a bitmask with one or more of the following + <itemizedlist> + <listitem>FT_UID - The msgono is a UID </listitem> + <listitem>FT_PEEK - Do not set the \Seen flag if not already set </listitem> + <listitem>FT_UID - The return string is in "internal" format, without any attempt to canonicalize CRLF </listitem> + </itemizedlist> </refsect1> </refentry> *************** *** 232,237 **** --- 244,250 ---- <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 *************** *** 262,301 **** <refsect1> <title>Description</title> <funcsynopsis> ! <funcdef>array <function>imap_header</function></funcdef> <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>int <parameter>msg_number</parameter></paramdef> </funcsynopsis> <para> ! This function returns an associative array of various header elements ! of the specified message. <para> <informalexample><literallayout> ! Date, From, From2, Subject, To, cc, ReplyTo, Recent, Unseen, ! Flagged, Deleted, Msgno, MailDate, Size ! </literallayout></informalexample> ! </refsect1> ! </refentry> ! <refentry id="function.imap-headerinfo"> ! <refnamediv> ! <refname>imap_headerinfo</refname> ! <refpurpose>Read the header of the messsage</refpurpose> ! </refnamediv> ! <refsect1> ! <title>Description</title> ! <funcsynopsis> ! <funcdef>array <function>imap_headerinfo</function></funcdef> ! <paramdef>int <parameter>imap_stream</parameter></paramdef> ! <paramdef>int <parameter>msg_number</parameter></paramdef> ! </funcsynopsis> ! <para> ! Same as <function>imap_header</function> </refsect1> </refentry> - <refentry id="function.imap-headers"> <refnamediv> <refname>imap_headers</refname> --- 275,352 ---- <refsect1> <title>Description</title> <funcsynopsis> ! <funcdef>object <function>imap_header</function></funcdef> <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>int <parameter>msg_number</parameter></paramdef> + <paramdef>int <parameter>fromlength</parameter></paramdef> + <paramdef>int <parameter>subjectlength</parameter></paramdef> + <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 email address) ! ! to[] (returns an array of objects from the To line, containing:) ! personal ! adl ! mailbox ! host ! ! fromaddress ! ! from[] (returns an array of objects from the From line, containing:) ! personal ! adl ! mailbox ! host ! ! ccaddress ! cc[] (returns an array of objects from the Cc line, containing:) ! personal ! adl ! mailbox ! host ! ! bccaddress ! bcc[] (returns an array of objects from the Bcc line, containing:) ! personal ! adl ! mailbox ! host ! ! reply_toaddress ! reply_to[] (returns an array of objects from the Reply_to line, containing:) ! personal ! adl ! mailbox ! host ! ! senderaddress ! sender[] (returns an array of objects from the sender line, containing:) ! personal ! adl ! mailbox ! host ! ! return_path ! return_path[] (returns an array of objects from the return_path line, containing:) ! personal ! adl ! mailbox ! host + udate ( mail message date in unix time) ! fetchfrom (from line formatted to fit <parameter>fromlength</parameter> characters) ! fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter> characters) ! </literallayout></informalexample> </refsect1> </refentry> <refentry id="function.imap-headers"> <refnamediv> <refname>imap_headers</refname> *************** *** 360,371 **** --- 411,428 ---- <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>string <parameter>mbox</parameter></paramdef> <paramdef>string <parameter>msglist</parameter></paramdef> + <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. msglist is a range not just message numbers. + <para> flags is a bitmask of one or more of + <itemizedlist> + <listitem>CP_UID - the sequence numbers contain UIDS</listitem> + <listitem>CP_MOVE - Delete the messages from the current mailbox after copying</listitem> + </itemizedlist> </refsect1> </refentry> *************** *** 439,447 **** --- 496,513 ---- <paramdef>string <parameter>mailbox</parameter></paramdef> <paramdef>string <parameter>username</parameter></paramdef> <paramdef>string <parameter>password</parameter></paramdef> + <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <para> Returns an IMAP stream on success and false on error. + <para> + the options are a bit mask with noe or more of the following: + <itemizedlist> + <listitem>OP_READONLY - Open mailbox read-only</listitem> + <listitem>OP_ANONYMOUS - Dont use or update a .newsrc for news</listitem> + <listitem>OP_HALFOPEN - For IMAP and NNTP names, open a connection but dont open a mailbox</listitem> + <listitem>CL_EXPUNGE - Expunge mailbox automatically upon mailbox close</listitem> + </itemizedlist> </refsect1> </refentry> *************** *** 506,511 **** --- 572,585 ---- 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 noe or more of the following: + <itemizedlist> + <listitem>OP_READONLY - Open mailbox read-only</listitem> + <listitem>OP_ANONYMOUS - Dont use or update a .newsrc for news</listitem> + <listitem>OP_HALFOPEN - For IMAP and NNTP names, open a connection but dont open a mailbox</listitem> + <listitem>CL_EXPUNGE - Expunge mailbox automatically upon mailbox close</listitem> + </itemizedlist> </refsect1> </refentry> *************** *** 606,612 **** --- 680,935 ---- </refsect1> </refentry> + <refentry id="function.imap-binary"> + <refnamediv> + <refname>imap_binary</refname> + <refpurpose>Convert an 8bit string to a base64 string.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <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> + + + + + <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> + <funcsynopsis> + <funcdef>array <function>imap_scanmailbox</function></funcdef> + <paramdef>int <parameter>imap_stream</parameter></paramdef> + <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> + + + + <refentry id="function.imap-mailboxmsginfo"> + <refnamediv> + <refname>imap_mailboxmsginfo</refname> + <refpurpose>Mailboxmsginfo current mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>array <function>imap_mailboxmsginfo</function></funcdef> + <paramdef>int <parameter>imap_stream</parameter></paramdef> + </funcsynopsis> + <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> + <literallayout> + Date : date of the message + Driver : driver + Mailbox : name of the mailbox + Nmsgs : number of messages + Recent : number of recent messages + Unread : number of unread messages + Size : mailbox size + </literallayout> + </informalexample> + </refsect1> + </refentry> + + + <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> + <funcsynopsis> + <funcdef>string <function>imap_rfc822_write_address</function></funcdef> + <paramdef>string <parameter>mailbox</parameter></paramdef> + <paramdef>string <parameter>host</parameter></paramdef> + <paramdef>string <parameter>personal</parameter></paramdef> + </funcsynopsis> + <para> + Returns a properly formatted email address given the mailbox, host, and personal info. + </refsect1> + </refentry> + + <refentry id="function.imap-rfc822_parse_adrlist"> + <refnamediv> + <refname>imap_rfc822_parse_adrlist</refname> + <refpurpose>Parses an address string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>string <function>imap_rfc822_parse_adrlist</function></funcdef> + <paramdef>string <parameter>address</parameter></paramdef> + <paramdef>string <parameter>default_host</parameter></paramdef> + </funcsynopsis> + <para> + Returns 3 objects given the input strings: + mailbox - the mailbox name (username) + host - the host name + personal - the personal name + </refsect1> + </refentry> + + <refentry id="function.imap-setflag_full"> + <refnamediv> + <refname>imap_setflag_full</refname> + <refpurpose>Sets flags on messages</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>string <function>imap_setflag_full</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>string <parameter>sequence</parameter></paramdef> + <paramdef>string <parameter>flag</parameter></paramdef> + <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> + + <refentry id="function.imap-clearflag_full"> + <refnamediv> + <refname>imap_clearflag_full</refname> + <refpurpose>Clears flags on messages</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>string <function>imap_clearflag_full</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>string <parameter>sequence</parameter></paramdef> + <paramdef>string <parameter>flag</parameter></paramdef> + <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: + ST_UID The sequence argument contains UIDs instead of + sequence numbers + </para> + </refsect1> + </refentry> + + <refentry id="function.imap-sort"> + <refnamediv> + <refname>imap_sort</refname> + <refpurpose></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis>Returns an array of message numbers sorted by the given parameters + <funcdef>string <function>imap_sort</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>criteria</parameter></paramdef> + <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 is a bitmask of one or more of the following: + 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 + + <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> + + + <refentry id="function.imap-fetchheader"> + <refnamediv> + <refname>imap_fetchheader</refname> + <refpurpose>Returns header for a message</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>string<function>imap_fetchheader</function></funcdef> + <paramdef>int <parameter>imap_stream</parameter></paramdef> + <paramdef>int <parameter>msgno</parameter></paramdef> + <paramdef>int <parameter>flags</parameter></paramdef> + </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 + 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) + + </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> + <funcsynopsis> + <funcdef>string <function>imap_uid</function></funcdef> + <paramdef>string <parameter>mailbox</parameter></paramdef> + <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