cvs: phpdoc /en/reference/imap/functions imap-8bit.xml imap-alerts.xml imap-append.xml imap-base64.xml imap-binary.xml imap-body.xml
imap-bodystruct.xml imap-check.xml imap-clearflag-full.xml imap-close.xml imap-createmailbox.xml imap-delete.xml imap-deletemailbox.xml
imap-errors.xml imap-expunge.xml imap-fetch-overview.xml imap-fetchbody.xml imap-fetchheader.xml imap-fetchstructure.xml imap-get-quota.xml
imap-get-quotaroot.xml imap-getacl.xml imap-getmailboxes.xml imap-getsubscribed.xml imap-header.xml imap-headerinfo.xml imap-headers.xml
imap-last-error.xml imap-list.xml imap-listmailbox.xml imap-listscan.xml imap-listsubscribed.xml imap-lsub.xml imap-mail-compose.xml
imap-mail-copy.xml imap-mail-move.xml imap-mail.xml imap-mailboxmsginfo.xml imap-mime-header-decode.xml imap-msgno.xml imap-num-msg.xml
imap-num-recent.xml imap-open.xml imap-ping.xml imap-qprint.xml imap-renamemailbox.xml imap-reopen.xml imap-rfc822-parse-adrlist.xml
imap-rfc822-parse-headers.xml im! ap-rfc822-write-address.xml imap-scanmailbox.xml imap-search.xml imap-set-quota.xml imap-setacl.xml
imap-setflag-full.xml imap-sort.xml imap-status.xml imap-subscribe.xml imap-thread.xml imap-timeout.xml imap-uid.xml imap-undelete.xml
imap-unsubscribe.xml imap-utf7-decode.xml imap-utf7-encode.xml imap-utf8.xml

didou Sun Jan 14 15:37:22 2007 UTC Modified files: /phpdoc/en/reference/imap/functions imap-8bit.xml imap-alerts.xml imap-append.xml imap-base64.xml imap-binary.xml imap-body.xml imap-bodystruct.xml imap-check.xml imap-clearflag-full.xml imap-close.xml imap-createmailbox.xml imap-delete.xml imap-deletemailbox.xml imap-errors.xml imap-expunge.xml imap-fetch-overview.xml imap-fetchbody.xml imap-fetchheader.xml imap-fetchstructure.xml imap-get-quota.xml imap-get-quotaroot.xml imap-getacl.xml imap-getmailboxes.xml imap-getsubscribed.xml imap-header.xml imap-headerinfo.xml imap-headers.xml imap-last-error.xml imap-list.xml imap-listmailbox.xml imap-listscan.xml imap-listsubscribed.xml imap-lsub.xml imap-mail-compose.xml imap-mail-copy.xml imap-mail-move.xml imap-mail.xml imap-mailboxmsginfo.xml imap-mime-header-decode.xml imap-msgno.xml imap-num-msg.xml imap-num-recent.xml imap-open.xml imap-ping.xml imap-qprint.xml imap-renamemailbox.xml imap-reopen.xml imap-rfc822-parse-adrlist.xml imap-rfc822-parse-headers.xml imap-rfc822-write-address.xml imap-scanmailbox.xml imap-search.xml imap-set-quota.xml imap-setacl.xml imap-setflag-full.xml imap-sort.xml imap-status.xml imap-subscribe.xml imap-thread.xml imap-timeout.xml imap-uid.xml imap-undelete.xml imap-unsubscribe.xml imap-utf7-decode.xml imap-utf7-encode.xml imap-utf8.xml Log: WS, prepare for new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-8bit.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-8bit.xml diff -u phpdoc/en/reference/imap/functions/imap-8bit.xml:1.3 phpdoc/en/reference/imap/functions/imap-8bit.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-8bit.xml:1.3 Wed May 7 21:31:30 2003 +++ phpdoc/en/reference/imap/functions/imap-8bit.xml Sun Jan 14 15:37:21 2007 @@ -1,32 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-8bit"> - <refnamediv> - <refname>imap_8bit</refname> - <refpurpose> - Convert an 8bit string to a quoted-printable string - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>imap_8bit</methodname> - <methodparam><type>string</type><parameter>string</parameter></methodparam> - </methodsynopsis> - <para> - Convert an 8bit string to a quoted-printable string (according to - <ulink url="&url.rfc;2045">RFC2045</ulink>, section - 6.7). - </para> - <para> - Returns a quoted-printable string. - </para> - <para> - See also <function>imap_qprint</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id="function.imap-8bit"> + <refnamediv> + <refname>imap_8bit</refname> + <refpurpose>Convert an 8bit string to a quoted-printable string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>imap_8bit</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> + <para> + Convert an 8bit string to a quoted-printable string (according to + <ulink url="&url.rfc;2045">RFC2045</ulink>, section + 6.7). + </para> + <para> + Returns a quoted-printable string. + </para> + <para> + See also <function>imap_qprint</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-alerts.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-alerts.xml diff -u phpdoc/en/reference/imap/functions/imap-alerts.xml:1.5 phpdoc/en/reference/imap/functions/imap-alerts.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-alerts.xml:1.5 Sun Apr 30 09:05:07 2006 +++ phpdoc/en/reference/imap/functions/imap-alerts.xml Sun Jan 14 15:37:21 2007 @@ -1,34 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-alerts"> - <refnamediv> - <refname>imap_alerts</refname> - <refpurpose> - This function returns all IMAP alert messages (if any) that have - occurred during this page request or since the alert stack was - reset - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_alerts</methodname> - <void/> - </methodsynopsis> - <para> - This function returns an array of all of the IMAP alert messages - generated since the last <function>imap_alerts</function> call, - or the beginning of the page. Returns &false; if no alert messages are - available. When <function>imap_alerts</function> is called, the alert - stack is subsequently cleared. The IMAP specification requires that these - messages be passed to the user. - </para> - <para> - See also <function>imap_errors</function> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.imap-alerts"> + <refnamediv> + <refname>imap_alerts</refname> + <refpurpose>This function returns all IMAP alert messages (if any) that have occurred during this page request or since the alert stack was reset</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_alerts</methodname> + <void/> + </methodsynopsis> + <para> + This function returns an array of all of the IMAP alert messages + generated since the last <function>imap_alerts</function> call, + or the beginning of the page. Returns &false; if no alert messages are + available. When <function>imap_alerts</function> is called, the alert + stack is subsequently cleared. The IMAP specification requires that these + messages be passed to the user. + </para> + <para> + See also <function>imap_errors</function> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-append.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-append.xml diff -u phpdoc/en/reference/imap/functions/imap-append.xml:1.10 phpdoc/en/reference/imap/functions/imap-append.xml:1.11 --- phpdoc/en/reference/imap/functions/imap-append.xml:1.10 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-append.xml Sun Jan 14 15:37:21 2007 @@ -1,40 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-append"> - <refnamediv> - <refname>imap_append</refname> - <refpurpose> - Append a string message to a specified mailbox - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_append</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> - <methodparam><type>string</type><parameter>message</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - <function>imap_append</function> appends a string message to the - specified mailbox <parameter>mbox</parameter>. If the optional - <parameter>options</parameter> is specified, writes the - <parameter>options</parameter> to that mailbox also. - </para> - <para> - &return.success; - </para> - <para> - When talking to the Cyrus IMAP server, you must use "\r\n" as - your end-of-line terminator instead of "\n" or the operation will - fail. - </para> - <para> - <example> - <title><function>imap_append</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.11 $ --> +<refentry id="function.imap-append"> + <refnamediv> + <refname>imap_append</refname> + <refpurpose>Append a string message to a specified mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_append</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + <function>imap_append</function> appends a string message to the + specified mailbox <parameter>mbox</parameter>. If the optional + <parameter>options</parameter> is specified, writes the + <parameter>options</parameter> to that mailbox also. + </para> + <para> + &return.success; + </para> + <para> + When talking to the Cyrus IMAP server, you must use "\r\n" as + your end-of-line terminator instead of "\n" or the operation will + fail. + </para> + <para> + <example> + <title><function>imap_append</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $stream = imap_open("{imap.example.org}INBOX.Drafts", "username", "password"); @@ -56,11 +53,11 @@ imap_close($stream); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-base64.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-base64.xml diff -u phpdoc/en/reference/imap/functions/imap-base64.xml:1.4 phpdoc/en/reference/imap/functions/imap-base64.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-base64.xml:1.4 Fri Jun 20 15:04:45 2003 +++ phpdoc/en/reference/imap/functions/imap-base64.xml Sun Jan 14 15:37:21 2007 @@ -1,29 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-base64"> - <refnamediv> - <refname>imap_base64</refname> - <refpurpose>Decode BASE64 encoded text</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>imap_base64</methodname> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - </methodsynopsis> - <para> - <function>imap_base64</function> function decodes BASE-64 encoded - <parameter>text</parameter> (see <ulink url="&url.rfc;2045">RFC2045</ulink>, - Section 6.8). The decoded message is returned as a string. - </para> - <para> - See also <function>imap_binary</function>, - <function>base64_encode</function> and - <function>base64_decode</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.imap-base64"> + <refnamediv> + <refname>imap_base64</refname> + <refpurpose>Decode BASE64 encoded text</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>imap_base64</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> + <para> + <function>imap_base64</function> function decodes BASE-64 encoded + <parameter>text</parameter> (see <ulink url="&url.rfc;2045">RFC2045</ulink>, + Section 6.8). The decoded message is returned as a string. + </para> + <para> + See also <function>imap_binary</function>, + <function>base64_encode</function> and + <function>base64_decode</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-binary.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-binary.xml diff -u phpdoc/en/reference/imap/functions/imap-binary.xml:1.3 phpdoc/en/reference/imap/functions/imap-binary.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-binary.xml:1.3 Wed May 7 21:31:30 2003 +++ phpdoc/en/reference/imap/functions/imap-binary.xml Sun Jan 14 15:37:21 2007 @@ -1,31 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <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> - <methodsynopsis> - <type>string</type><methodname>imap_binary</methodname> - <methodparam><type>string</type><parameter>string</parameter></methodparam> - </methodsynopsis> - <para> - Convert an 8bit string to a base64 string (according to <ulink - url="&url.rfc;2045">RFC2045</ulink>, Section 6.8). - </para> - <para> - Returns a base64 string. - </para> - <para> - See also <function>imap_base64</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<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> + <methodsynopsis> + <type>string</type><methodname>imap_binary</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> + <para> + Convert an 8bit string to a base64 string (according to <ulink + url="&url.rfc;2045">RFC2045</ulink>, Section 6.8). + </para> + <para> + Returns a base64 string. + </para> + <para> + See also <function>imap_base64</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-body.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-body.xml diff -u phpdoc/en/reference/imap/functions/imap-body.xml:1.5 phpdoc/en/reference/imap/functions/imap-body.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-body.xml:1.5 Mon Mar 8 09:18:40 2004 +++ phpdoc/en/reference/imap/functions/imap-body.xml Sun Jan 14 15:37:21 2007 @@ -1,55 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-body"> - <refnamediv> - <refname>imap_body</refname> - <refpurpose>Read the message body</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>imap_body</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - <function>imap_body</function> returns the body of the message, - numbered <parameter>msg_number</parameter> in the current - mailbox. - </para> - <para> - The optional <parameter>options</parameter> are a bit mask - with one or more of the following: - <itemizedlist> - <listitem> - <simpara> - <constant>FT_UID</constant> - The <parameter>msg_number</parameter> is a UID - </simpara> - </listitem> - <listitem> - <simpara> - <constant>FT_PEEK</constant> - Do not set the \Seen flag if not already set - </simpara> - </listitem> - <listitem> - <simpara> - <constant>FT_INTERNAL</constant> - The return string is in internal format, will - not canonicalize to CRLF. - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - <function>imap_body</function> will only return a verbatim copy of the - message body. To extract single parts of a multipart MIME-encoded - message you have to use <function>imap_fetchstructure</function> to - analyze its structure and <function>imap_fetchbody</function> to - extract a copy of a single body component. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.imap-body"> + <refnamediv> + <refname>imap_body</refname> + <refpurpose>Read the message body</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>imap_body</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + <function>imap_body</function> returns the body of the message, + numbered <parameter>msg_number</parameter> in the current + mailbox. + </para> + <para> + The optional <parameter>options</parameter> are a bit mask + with one or more of the following: + <itemizedlist> + <listitem> + <simpara> + <constant>FT_UID</constant> - The <parameter>msg_number</parameter> is a UID + </simpara> + </listitem> + <listitem> + <simpara> + <constant>FT_PEEK</constant> - Do not set the \Seen flag if not already set + </simpara> + </listitem> + <listitem> + <simpara> + <constant>FT_INTERNAL</constant> - The return string is in internal format, will + not canonicalize to CRLF. + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + <function>imap_body</function> will only return a verbatim copy of the + message body. To extract single parts of a multipart MIME-encoded + message you have to use <function>imap_fetchstructure</function> to + analyze its structure and <function>imap_fetchbody</function> to + extract a copy of a single body component. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-bodystruct.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-bodystruct.xml diff -u phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.4 phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.4 Tue Aug 31 01:20:59 2004 +++ phpdoc/en/reference/imap/functions/imap-bodystruct.xml Sun Jan 14 15:37:21 2007 @@ -1,26 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 --> - <refentry id='function.imap-bodystruct'> - <refnamediv> - <refname>imap_bodystruct</refname> - <refpurpose> - Read the structure of a specified body section of a specific message - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>imap_bodystruct</methodname> - <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>int</type><parameter>msg_no</parameter></methodparam> - <methodparam><type>string</type><parameter>section</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id='function.imap-bodystruct'> + <refnamediv> + <refname>imap_bodystruct</refname> + <refpurpose>Read the structure of a specified body section of a specific message</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>imap_bodystruct</methodname> + <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_no</parameter></methodparam> + <methodparam><type>string</type><parameter>section</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-check.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-check.xml diff -u phpdoc/en/reference/imap/functions/imap-check.xml:1.5 phpdoc/en/reference/imap/functions/imap-check.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-check.xml:1.5 Tue Sep 12 21:45:30 2006 +++ phpdoc/en/reference/imap/functions/imap-check.xml Sun Jan 14 15:37:21 2007 @@ -1,60 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-check"> - <refnamediv> - <refname>imap_check</refname> - <refpurpose>Check current mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>imap_check</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - </methodsynopsis> - <para> - Returns information about the current mailbox. Returns &false; on - failure. - </para> - <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> - <para> - <itemizedlist> - <listitem> - <simpara> - Date - current system time formatted according to <ulink - url="&url.rfc;2822">RFC2822</ulink> - </simpara> - </listitem> - <listitem> - <simpara> - Driver - protocol used to access this mailbox: POP3, IMAP, NNTP - </simpara> - </listitem> - <listitem> - <simpara> - Mailbox - the mailbox name - </simpara> - </listitem> - <listitem> - <simpara> - Nmsgs - number of messages in the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - Recent - number of recent messages in the mailbox - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - <example> - <title><function>imap_check</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.6 $ --> +<refentry id="function.imap-check"> + <refnamediv> + <refname>imap_check</refname> + <refpurpose>Check current mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>imap_check</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> + <para> + Returns information about the current mailbox. Returns &false; on + failure. + </para> + <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> + <para> + <itemizedlist> + <listitem> + <simpara> + Date - current system time formatted according to <ulink + url="&url.rfc;2822">RFC2822</ulink> + </simpara> + </listitem> + <listitem> + <simpara> + Driver - protocol used to access this mailbox: POP3, IMAP, NNTP + </simpara> + </listitem> + <listitem> + <simpara> + Mailbox - the mailbox name + </simpara> + </listitem> + <listitem> + <simpara> + Nmsgs - number of messages in the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + Recent - number of recent messages in the mailbox + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + <example> + <title><function>imap_check</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -63,11 +62,11 @@ ?> ]]> - </programlisting> - <para> - this will output : - </para> - <screen> + </programlisting> + <para> + this will output : + </para> + <screen> <![CDATA[ object(stdClass)(5) { ["Date"]=> @@ -83,11 +82,11 @@ int(0) } ]]> - </screen> - </example> - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-clearflag-full.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-clearflag-full.xml diff -u phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.7 phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-clearflag-full.xml:1.7 Tue Sep 12 21:43:35 2006 +++ phpdoc/en/reference/imap/functions/imap-clearflag-full.xml Sun Jan 14 15:37:21 2007 @@ -1,45 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-clearflag-full"> - <refnamediv> - <refname>imap_clearflag_full</refname> - <refpurpose>Clears flags on messages</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_clearflag_full</methodname> - <methodparam><type>resource</type><parameter>stream</parameter></methodparam> - <methodparam><type>string</type><parameter>sequence</parameter></methodparam> - <methodparam><type>string</type><parameter>flag</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - This function causes a store to delete the specified - <parameter>flag</parameter> to the flags set for the - messages in the specified <parameter>sequence</parameter>. - The flags which you can unset are "\\Seen", "\\Answered", - "\\Flagged", "\\Deleted", and "\\Draft" (as defined - by <ulink url="&url.rfc;2060">RFC2060</ulink>). &return.success;. - </para> - <para> - <parameter>options</parameter> are a bit mask and may contain - the single option: - <itemizedlist> - <listitem> - <simpara> - <constant>ST_UID</constant> - The sequence argument contains UIDs - instead of sequence numbers - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - See also: <function>imap_setflag_full</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.8 $ --> +<refentry id="function.imap-clearflag-full"> + <refnamediv> + <refname>imap_clearflag_full</refname> + <refpurpose>Clears flags on messages</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_clearflag_full</methodname> + <methodparam><type>resource</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>sequence</parameter></methodparam> + <methodparam><type>string</type><parameter>flag</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + This function causes a store to delete the specified + <parameter>flag</parameter> to the flags set for the + messages in the specified <parameter>sequence</parameter>. + The flags which you can unset are "\\Seen", "\\Answered", + "\\Flagged", "\\Deleted", and "\\Draft" (as defined + by <ulink url="&url.rfc;2060">RFC2060</ulink>). &return.success;. + </para> + <para> + <parameter>options</parameter> are a bit mask and may contain + the single option: + <itemizedlist> + <listitem> + <simpara> + <constant>ST_UID</constant> - The sequence argument contains UIDs + instead of sequence numbers + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + See also: <function>imap_setflag_full</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-close.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-close.xml diff -u phpdoc/en/reference/imap/functions/imap-close.xml:1.7 phpdoc/en/reference/imap/functions/imap-close.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-close.xml:1.7 Mon Mar 8 09:18:40 2004 +++ phpdoc/en/reference/imap/functions/imap-close.xml Sun Jan 14 15:37:21 2007 @@ -1,29 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-close"> - <refnamediv> - <refname>imap_close</refname> - <refpurpose>Close an IMAP stream</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_close</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam> - </methodsynopsis> - <para> - Closes the imap stream. Takes an optional - <parameter>flag</parameter> <constant>CL_EXPUNGE</constant>, - which will silently expunge the mailbox before closing, - removing all messages marked for deletion. - </para> - <para> - See also: <function>imap_open</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.8 $ --> +<refentry id="function.imap-close"> + <refnamediv> + <refname>imap_close</refname> + <refpurpose>Close an IMAP stream</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_close</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam> + </methodsynopsis> + <para> + Closes the imap stream. Takes an optional + <parameter>flag</parameter> <constant>CL_EXPUNGE</constant>, + which will silently expunge the mailbox before closing, + removing all messages marked for deletion. + </para> + <para> + See also: <function>imap_open</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-createmailbox.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-createmailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.10 phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.11 --- phpdoc/en/reference/imap/functions/imap-createmailbox.xml:1.10 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-createmailbox.xml Sun Jan 14 15:37:21 2007 @@ -1,30 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-createmailbox"> - <refnamediv> - <refname>imap_createmailbox</refname> - <refpurpose>Create a new mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_createmailbox</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> - </methodsynopsis> - <para> - <function>imap_createmailbox</function> creates a new mailbox - specified by <parameter>mbox</parameter>. Names containing - international characters should be encoded by <function>imap_utf7_encode</function> - </para> - <para> - &return.success;. - </para> - <para> - <example> - <title><function>imap_createmailbox</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.11 $ --> +<refentry id="function.imap-createmailbox"> + <refnamediv> + <refname>imap_createmailbox</refname> + <refpurpose>Create a new mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_createmailbox</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + </methodsynopsis> + <para> + <function>imap_createmailbox</function> creates a new mailbox + specified by <parameter>mbox</parameter>. Names containing + international characters should be encoded by <function>imap_utf7_encode</function> + </para> + <para> + &return.success;. + </para> + <para> + <example> + <title><function>imap_createmailbox</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN) @@ -39,7 +38,7 @@ // 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 +// your inbox to its initial state if (@imap_createmailbox($mbox, imap_utf7_encode("{imap.example.org}INBOX.$newname"))) { $status = @imap_status($mbox, "{imap.example.org}INBOX.$newname", SA_ALL); @@ -60,7 +59,7 @@ } else { echo "imap_status on new mailbox failed: " . imap_last_error() . "<br />\n"; } - + if (@imap_deletemailbox($mbox, "{imap.example.org}INBOX.$newname")) { echo "new mailbox removed to restore initial state<br />\n"; } else { @@ -74,17 +73,17 @@ imap_close($mbox); ?> ]]> - </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> + </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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-delete.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-delete.xml diff -u phpdoc/en/reference/imap/functions/imap-delete.xml:1.9 phpdoc/en/reference/imap/functions/imap-delete.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-delete.xml:1.9 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-delete.xml Sun Jan 14 15:37:21 2007 @@ -1,48 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-delete"> - <refnamediv> - <refname>imap_delete</refname> - <refpurpose> - Mark a message for deletion from current mailbox - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_delete</methodname> - <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - Returns &true;. - </para> - <para> - <function>imap_delete</function> marks messages listed - in <parameter>msg_number</parameter> for deletion. The optional - <parameter>flags</parameter> parameter only has a single option, - <parameter>FT_UID</parameter>, which tells the function to treat - the <parameter>msg_number</parameter> argument as a - <parameter>UID</parameter>. Messages marked for deletion will - stay in the mailbox until either - <function>imap_expunge</function> is called or - <function>imap_close</function> is called with the optional - parameter CL_EXPUNGE. - </para> - <note> - <para> - POP3 mailboxes do not have their message flags saved between - connections, so <function>imap_expunge</function> must be called during - the same connection in order for messages marked for deletion to - actually be purged. - </para> - </note> - <para> - <example> - <title><function>imap_delete</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.10 $ --> +<refentry id="function.imap-delete"> + <refnamediv> + <refname>imap_delete</refname> + <refpurpose>Mark a message for deletion from current mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_delete</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + Returns &true;. + </para> + <para> + <function>imap_delete</function> marks messages listed + in <parameter>msg_number</parameter> for deletion. The optional + <parameter>flags</parameter> parameter only has a single option, + <parameter>FT_UID</parameter>, which tells the function to treat + the <parameter>msg_number</parameter> argument as a + <parameter>UID</parameter>. Messages marked for deletion will + stay in the mailbox until either + <function>imap_expunge</function> is called or + <function>imap_close</function> is called with the optional + parameter CL_EXPUNGE. + </para> + <note> + <para> + POP3 mailboxes do not have their message flags saved between + connections, so <function>imap_expunge</function> must be called during + the same connection in order for messages marked for deletion to + actually be purged. + </para> + </note> + <para> + <example> + <title><function>imap_delete</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -65,16 +62,16 @@ 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> + </programlisting> + </example> + </para> + <para> + See also: <function>imap_undelete</function>, + <function>imap_expunge</function>, and + <function>imap_close</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-deletemailbox.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-deletemailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.4 phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-deletemailbox.xml:1.4 Mon Mar 8 09:18:41 2004 +++ phpdoc/en/reference/imap/functions/imap-deletemailbox.xml Sun Jan 14 15:37:21 2007 @@ -1,34 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-deletemailbox"> - <refnamediv> - <refname>imap_deletemailbox</refname> - <refpurpose>Delete a mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_deletemailbox</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> - </methodsynopsis> - <para> - <function>imap_deletemailbox</function> deletes the specified - mailbox (see <function>imap_open</function> for the format - of <parameter>mbox</parameter> names). - </para> - <para> - &return.success;. - </para> - <para> - See also <function>imap_createmailbox</function>, - <function>imap_renamemailbox</function>, and - <function>imap_open</function> for the format of - <parameter>mbox</parameter>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.imap-deletemailbox"> + <refnamediv> + <refname>imap_deletemailbox</refname> + <refpurpose>Delete a mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_deletemailbox</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + </methodsynopsis> + <para> + <function>imap_deletemailbox</function> deletes the specified + mailbox (see <function>imap_open</function> for the format + of <parameter>mbox</parameter> names). + </para> + <para> + &return.success;. + </para> + <para> + See also <function>imap_createmailbox</function>, + <function>imap_renamemailbox</function>, and + <function>imap_open</function> for the format of + <parameter>mbox</parameter>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-errors.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-errors.xml diff -u phpdoc/en/reference/imap/functions/imap-errors.xml:1.6 phpdoc/en/reference/imap/functions/imap-errors.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-errors.xml:1.6 Sun Apr 30 09:05:07 2006 +++ phpdoc/en/reference/imap/functions/imap-errors.xml Sun Jan 14 15:37:21 2007 @@ -1,34 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-errors"> - <refnamediv> - <refname>imap_errors</refname> - <refpurpose> - This function returns all of the IMAP errors (if any) that have - occurred during this page request or since the error stack was - reset - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_errors</methodname> - <void/> - </methodsynopsis> - <para> - This function returns an array of all of the IMAP error messages - generated since the last <function>imap_errors</function> call, - or the beginning of the page. Returns &false; if no error messages are - available. When <function>imap_errors</function> is called, the error - stack is subsequently cleared. - </para> - <para> - See also <function>imap_last_error</function>&listendand; - <function>imap_alerts</function> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<refentry id="function.imap-errors"> + <refnamediv> + <refname>imap_errors</refname> + <refpurpose>This function returns all of the IMAP errors (if any) that have occurred during this page request or since the error stack was reset</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_errors</methodname> + <void/> + </methodsynopsis> + <para> + This function returns an array of all of the IMAP error messages + generated since the last <function>imap_errors</function> call, + or the beginning of the page. Returns &false; if no error messages are + available. When <function>imap_errors</function> is called, the error + stack is subsequently cleared. + </para> + <para> + See also <function>imap_last_error</function>&listendand; + <function>imap_alerts</function> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-expunge.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-expunge.xml diff -u phpdoc/en/reference/imap/functions/imap-expunge.xml:1.3 phpdoc/en/reference/imap/functions/imap-expunge.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-expunge.xml:1.3 Wed Oct 9 14:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-expunge.xml Sun Jan 14 15:37:21 2007 @@ -1,28 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-expunge"> - <refnamediv> - <refname>imap_expunge</refname> - <refpurpose>Delete all messages marked for deletion</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_expunge</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - </methodsynopsis> - <para> - <function>imap_expunge</function> deletes all the messages marked - for deletion by <function>imap_delete</function>, - <function>imap_mail_move</function>, or - <function>imap_setflag_full</function>. - </para> - <para> - Returns &true;. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id="function.imap-expunge"> + <refnamediv> + <refname>imap_expunge</refname> + <refpurpose>Delete all messages marked for deletion</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_expunge</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> + <para> + <function>imap_expunge</function> deletes all the messages marked + for deletion by <function>imap_delete</function>, + <function>imap_mail_move</function>, or + <function>imap_setflag_full</function>. + </para> + <para> + Returns &true;. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetch-overview.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-fetch-overview.xml diff -u phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.10 phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.11 --- phpdoc/en/reference/imap/functions/imap-fetch-overview.xml:1.10 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-fetch-overview.xml Sun Jan 14 15:37:21 2007 @@ -1,136 +1,133 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-fetch-overview"> - <refnamediv> - <refname>imap_fetch_overview</refname> - <refpurpose> - Read an overview of the information in the headers of the given message - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_fetch_overview</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>sequence</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - This function fetches mail headers for the given - <parameter>sequence</parameter> and returns an overview of their - contents. <parameter>sequence</parameter> will contain a sequence - of message indices or UIDs, if <parameter>flags</parameter> - contains FT_UID. The returned value is an array of objects - describing one message header each: - <itemizedlist> - <listitem> - <simpara> - subject - the messages subject - </simpara> - </listitem> - <listitem> - <simpara> - from - who sent it - </simpara> - </listitem> - <listitem> - <simpara> - to - recipient - </simpara> - </listitem> - <listitem> - <simpara> - date - when was it sent - </simpara> - </listitem> - <listitem> - <simpara> - message_id - Message-ID - </simpara> - </listitem> - <listitem> - <simpara> - references - is a reference to this message id - </simpara> - </listitem> - <listitem> - <simpara> - in_reply_to - is a reply to this message id - </simpara> - </listitem> - <listitem> - <simpara> - size - size in bytes - </simpara> - </listitem> - <listitem> - <simpara> - uid - UID the message has in the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - msgno - message sequence number in the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - recent - this message is flagged as recent - </simpara> - </listitem> - <listitem> - <simpara> - flagged - this message is flagged - </simpara> - </listitem> - <listitem> - <simpara> - answered - this message is flagged as answered - </simpara> - </listitem> - <listitem> - <simpara> - deleted - this message is flagged for deletion - </simpara> - </listitem> - <listitem> - <simpara> - seen - this message is flagged as already read - </simpara> - </listitem> - <listitem> - <simpara> - draft - this message is flagged as being a draft - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - <example> - <title><function>imap_fetch_overview</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.11 $ --> +<refentry id="function.imap-fetch-overview"> + <refnamediv> + <refname>imap_fetch_overview</refname> + <refpurpose>Read an overview of the information in the headers of the given message</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_fetch_overview</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>sequence</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + This function fetches mail headers for the given + <parameter>sequence</parameter> and returns an overview of their + contents. <parameter>sequence</parameter> will contain a sequence + of message indices or UIDs, if <parameter>flags</parameter> + contains FT_UID. The returned value is an array of objects + describing one message header each: + <itemizedlist> + <listitem> + <simpara> + subject - the messages subject + </simpara> + </listitem> + <listitem> + <simpara> + from - who sent it + </simpara> + </listitem> + <listitem> + <simpara> + to - recipient + </simpara> + </listitem> + <listitem> + <simpara> + date - when was it sent + </simpara> + </listitem> + <listitem> + <simpara> + message_id - Message-ID + </simpara> + </listitem> + <listitem> + <simpara> + references - is a reference to this message id + </simpara> + </listitem> + <listitem> + <simpara> + in_reply_to - is a reply to this message id + </simpara> + </listitem> + <listitem> + <simpara> + size - size in bytes + </simpara> + </listitem> + <listitem> + <simpara> + uid - UID the message has in the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + msgno - message sequence number in the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + recent - this message is flagged as recent + </simpara> + </listitem> + <listitem> + <simpara> + flagged - this message is flagged + </simpara> + </listitem> + <listitem> + <simpara> + answered - this message is flagged as answered + </simpara> + </listitem> + <listitem> + <simpara> + deleted - this message is flagged for deletion + </simpara> + </listitem> + <listitem> + <simpara> + seen - this message is flagged as already read + </simpara> + </listitem> + <listitem> + <simpara> + draft - this message is flagged as being a draft + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + <example> + <title><function>imap_fetch_overview</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org:143}", "username", "password") or die("can't connect: " . imap_last_error()); - + $overview = imap_fetch_overview($mbox, "2,4:6", 0); - + if (is_array($overview)) { foreach ($overview as $val) { echo "$val->msgno - $val->date - $val->subject\n"; } } - + imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetchbody.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-fetchbody.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.5 phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-fetchbody.xml:1.5 Fri Aug 13 16:12:05 2004 +++ phpdoc/en/reference/imap/functions/imap-fetchbody.xml Sun Jan 14 15:37:21 2007 @@ -1,58 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <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> - <methodsynopsis> - <type>string</type><methodname>imap_fetchbody</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> - <methodparam><type>string</type><parameter>part_number</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - This function causes a fetch of a particular section of the body - of the specified messages as a text string and returns that text - string. The section specification is a string of integers - delimited by period which index into a body part list as per the - IMAP4 specification. Body parts are not decoded by this function. - </para> - <para> - The <parameter>options</parameter> for - <function>imap_fetchbody</function> is a bitmask with one or more - of the following: - <itemizedlist> - <listitem> - <simpara> - <constant>FT_UID</constant> - The <parameter>msg_number</parameter> is a UID - </simpara> - </listitem> - <listitem> - <simpara> - <constant>FT_PEEK</constant> - Do not set the \Seen flag if - not already set - </simpara> - </listitem> - <listitem> - <simpara> - <constant>FT_INTERNAL</constant> - The return string is in - internal format, will not canonicalize to CRLF. - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - See also: <function>imap_fetchstructure</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<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> + <methodsynopsis> + <type>string</type><methodname>imap_fetchbody</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam><type>string</type><parameter>part_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + This function causes a fetch of a particular section of the body + of the specified messages as a text string and returns that text + string. The section specification is a string of integers + delimited by period which index into a body part list as per the + IMAP4 specification. Body parts are not decoded by this function. + </para> + <para> + The <parameter>options</parameter> for + <function>imap_fetchbody</function> is a bitmask with one or more + of the following: + <itemizedlist> + <listitem> + <simpara> + <constant>FT_UID</constant> - The <parameter>msg_number</parameter> is a UID + </simpara> + </listitem> + <listitem> + <simpara> + <constant>FT_PEEK</constant> - Do not set the \Seen flag if + not already set + </simpara> + </listitem> + <listitem> + <simpara> + <constant>FT_INTERNAL</constant> - The return string is in + internal format, will not canonicalize to CRLF. + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + See also: <function>imap_fetchstructure</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetchheader.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-fetchheader.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.6 phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-fetchheader.xml:1.6 Mon Mar 8 09:18:41 2004 +++ phpdoc/en/reference/imap/functions/imap-fetchheader.xml Sun Jan 14 15:37:21 2007 @@ -1,53 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-fetchheader"> - <refnamediv> - <refname>imap_fetchheader</refname> - <refpurpose>Returns header for a message</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>imap_fetchheader</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>msgno</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - This function causes a fetch of the complete, unfiltered - <ulink url="&url.rfc;2822">RFC2822</ulink> - format header of the specified message as a text string and - returns that text string. - </para> - <para> - The <parameter>options</parameter> are: - <itemizedlist> - <listitem> - <simpara> - <constant>FT_UID</constant> - The <parameter>msgno</parameter> - argument is a UID - </simpara> - </listitem> - <listitem> - <simpara> - <constant>FT_INTERNAL</constant> - The return string - is in "internal" format, without any attempt to - canonicalize to CRLF newlines - </simpara> - </listitem> - <listitem> - <simpara> - <constant>FT_PREFETCHTEXT</constant> - The RFC822.TEXT - should be pre-fetched at the same time. This avoids an - extra RTT on an IMAP connection if a full message text is - desired (e.g. in a "save to local file" operation) - </simpara> - </listitem> - </itemizedlist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<refentry id="function.imap-fetchheader"> + <refnamediv> + <refname>imap_fetchheader</refname> + <refpurpose>Returns header for a message</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>imap_fetchheader</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msgno</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + This function causes a fetch of the complete, unfiltered + <ulink url="&url.rfc;2822">RFC2822</ulink> + format header of the specified message as a text string and + returns that text string. + </para> + <para> + The <parameter>options</parameter> are: + <itemizedlist> + <listitem> + <simpara> + <constant>FT_UID</constant> - The <parameter>msgno</parameter> + argument is a UID + </simpara> + </listitem> + <listitem> + <simpara> + <constant>FT_INTERNAL</constant> - The return string + is in "internal" format, without any attempt to + canonicalize to CRLF newlines + </simpara> + </listitem> + <listitem> + <simpara> + <constant>FT_PREFETCHTEXT</constant> - The RFC822.TEXT + should be pre-fetched at the same time. This avoids an + extra RTT on an IMAP connection if a full message text is + desired (e.g. in a "save to local file" operation) + </simpara> + </listitem> + </itemizedlist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-fetchstructure.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-fetchstructure.xml diff -u phpdoc/en/reference/imap/functions/imap-fetchstructure.xml:1.7 phpdoc/en/reference/imap/functions/imap-fetchstructure.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-fetchstructure.xml:1.7 Sun Oct 15 03:44:38 2006 +++ phpdoc/en/reference/imap/functions/imap-fetchstructure.xml Sun Jan 14 15:37:21 2007 @@ -1,152 +1,149 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-fetchstructure"> - <refnamediv> - <refname>imap_fetchstructure</refname> - <refpurpose> - Read the structure of a particular message - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>imap_fetchstructure</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - This function fetches all the structured information for a given - message. The optional <parameter>options</parameter> parameter only - has a single option, <parameter>FT_UID</parameter>, which tells - the function to treat the <parameter>msg_number</parameter> - argument as a <parameter>UID</parameter>. The returned object - includes the envelope, internal date, size, flags and body - structure along with a similar object for each mime - attachment. The structure of the returned objects is as follows: - </para> - <para> - <table> - <title> - Returned Objects for <function>imap_fetchstructure</function> - </title> - <tgroup cols="2"> - <tbody> - <row> - <entry>type</entry> - <entry>Primary body type</entry> - </row> - <row> - <entry>encoding</entry> - <entry>Body transfer encoding</entry> - </row> - <row> - <entry>ifsubtype</entry> - <entry>&true; if there is a subtype string</entry> - </row> - <row> - <entry>subtype</entry> - <entry><acronym>MIME</acronym> subtype</entry> - </row> - <row> - <entry>ifdescription</entry> - <entry>&true; if there is a description string</entry> - </row> - <row> - <entry>description</entry> - <entry>Content description string</entry> - </row> - <row> - <entry>ifid</entry> - <entry>&true; if there is an identification string</entry> - </row> - <row> - <entry>id</entry> - <entry>Identification string</entry> - </row> - <row> - <entry>lines</entry> - <entry>Number of lines</entry> - </row> - <row> - <entry>bytes</entry> - <entry>Number of bytes</entry> - </row> - <row> - <entry>ifdisposition</entry> - <entry>&true; if there is a disposition string</entry> - </row> - <row> - <entry>disposition</entry> - <entry>Disposition string</entry> - </row> - <row> - <entry>ifdparameters</entry> - <entry>&true; if the dparameters array exists</entry> - </row> - <row> - <entry>dparameters</entry> - <entry>An array of objects where each object has an "attribute" and a - "value" property corresponding to the parameters on the - Content-disposition <acronym>MIME</acronym>header.</entry> - </row> - <row> - <entry>ifparameters</entry> - <entry>&true; if the parameters array exists</entry> - </row> - <row> - <entry>parameters</entry> - <entry>An array of objects where each object has an "attribute" and - a "value" property.</entry> - </row> - <row> - <entry>parts</entry> - <entry>An array of objects identical in structure to the top-level - object, each of which corresponds to a <acronym>MIME</acronym> body - part.</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - <table> - <title>Primary body type</title> - <tgroup cols="2"> - <tbody> - <row><entry>0</entry><entry>text</entry></row> - <row><entry>1</entry><entry>multipart</entry></row> - <row><entry>2</entry><entry>message</entry></row> - <row><entry>3</entry><entry>application</entry></row> - <row><entry>4</entry><entry>audio</entry></row> - <row><entry>5</entry><entry>image</entry></row> - <row><entry>6</entry><entry>video</entry></row> - <row><entry>7</entry><entry>other</entry></row> - </tbody> - </tgroup> - </table> - </para> - <para> - <table> - <title>Transfer encodings</title> - <tgroup cols="2"> - <tbody> - <row><entry>0</entry><entry>7BIT</entry></row> - <row><entry>1</entry><entry>8BIT</entry></row> - <row><entry>2</entry><entry>BINARY</entry></row> - <row><entry>3</entry><entry>BASE64</entry></row> - <row><entry>4</entry><entry>QUOTED-PRINTABLE</entry></row> - <row><entry>5</entry><entry>OTHER</entry></row> - </tbody> - </tgroup> - </table> - </para> - <para> - See also: <function>imap_fetchbody</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.8 $ --> +<refentry id="function.imap-fetchstructure"> + <refnamediv> + <refname>imap_fetchstructure</refname> + <refpurpose>Read the structure of a particular message</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>imap_fetchstructure</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + This function fetches all the structured information for a given + message. The optional <parameter>options</parameter> parameter only + has a single option, <parameter>FT_UID</parameter>, which tells + the function to treat the <parameter>msg_number</parameter> + argument as a <parameter>UID</parameter>. The returned object + includes the envelope, internal date, size, flags and body + structure along with a similar object for each mime + attachment. The structure of the returned objects is as follows: + </para> + <para> + <table> + <title> + Returned Objects for <function>imap_fetchstructure</function> + </title> + <tgroup cols="2"> + <tbody> + <row> + <entry>type</entry> + <entry>Primary body type</entry> + </row> + <row> + <entry>encoding</entry> + <entry>Body transfer encoding</entry> + </row> + <row> + <entry>ifsubtype</entry> + <entry>&true; if there is a subtype string</entry> + </row> + <row> + <entry>subtype</entry> + <entry><acronym>MIME</acronym> subtype</entry> + </row> + <row> + <entry>ifdescription</entry> + <entry>&true; if there is a description string</entry> + </row> + <row> + <entry>description</entry> + <entry>Content description string</entry> + </row> + <row> + <entry>ifid</entry> + <entry>&true; if there is an identification string</entry> + </row> + <row> + <entry>id</entry> + <entry>Identification string</entry> + </row> + <row> + <entry>lines</entry> + <entry>Number of lines</entry> + </row> + <row> + <entry>bytes</entry> + <entry>Number of bytes</entry> + </row> + <row> + <entry>ifdisposition</entry> + <entry>&true; if there is a disposition string</entry> + </row> + <row> + <entry>disposition</entry> + <entry>Disposition string</entry> + </row> + <row> + <entry>ifdparameters</entry> + <entry>&true; if the dparameters array exists</entry> + </row> + <row> + <entry>dparameters</entry> + <entry>An array of objects where each object has an "attribute" and a + "value" property corresponding to the parameters on the + Content-disposition <acronym>MIME</acronym>header.</entry> + </row> + <row> + <entry>ifparameters</entry> + <entry>&true; if the parameters array exists</entry> + </row> + <row> + <entry>parameters</entry> + <entry>An array of objects where each object has an "attribute" and + a "value" property.</entry> + </row> + <row> + <entry>parts</entry> + <entry>An array of objects identical in structure to the top-level + object, each of which corresponds to a <acronym>MIME</acronym> body + part.</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + <table> + <title>Primary body type</title> + <tgroup cols="2"> + <tbody> + <row><entry>0</entry><entry>text</entry></row> + <row><entry>1</entry><entry>multipart</entry></row> + <row><entry>2</entry><entry>message</entry></row> + <row><entry>3</entry><entry>application</entry></row> + <row><entry>4</entry><entry>audio</entry></row> + <row><entry>5</entry><entry>image</entry></row> + <row><entry>6</entry><entry>video</entry></row> + <row><entry>7</entry><entry>other</entry></row> + </tbody> + </tgroup> + </table> + </para> + <para> + <table> + <title>Transfer encodings</title> + <tgroup cols="2"> + <tbody> + <row><entry>0</entry><entry>7BIT</entry></row> + <row><entry>1</entry><entry>8BIT</entry></row> + <row><entry>2</entry><entry>BINARY</entry></row> + <row><entry>3</entry><entry>BASE64</entry></row> + <row><entry>4</entry><entry>QUOTED-PRINTABLE</entry></row> + <row><entry>5</entry><entry>OTHER</entry></row> + </tbody> + </tgroup> + </table> + </para> + <para> + See also: <function>imap_fetchbody</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-get-quota.xml?r1=1.15&r2=1.16&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-get-quota.xml diff -u phpdoc/en/reference/imap/functions/imap-get-quota.xml:1.15 phpdoc/en/reference/imap/functions/imap-get-quota.xml:1.16 --- phpdoc/en/reference/imap/functions/imap-get-quota.xml:1.15 Tue Sep 12 21:43:35 2006 +++ phpdoc/en/reference/imap/functions/imap-get-quota.xml Sun Jan 14 15:37:21 2007 @@ -1,113 +1,110 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.15 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-get-quota"> - <refnamediv> - <refname>imap_get_quota</refname> - <refpurpose> - Retrieve the quota level settings, and usage statics per mailbox - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_get_quota</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> - </methodsynopsis> - <para> - Returns an array with integer values limit and usage for the given - mailbox. The value of limit represents the total amount of space - allowed for this mailbox. The usage value represents the mailboxes - current level of capacity. Will return &false; in the case of failure. - </para> - <para> - This function is currently only available to users of the c-client2000 - or greater library. - </para> - <para> - NOTE: For this function to work, the mail stream is required to be opened - as the mail-admin user. For a non-admin user version of this function, - please see the <function>imap_get_quotaroot</function> function of PHP. - </para> - <para> - <parameter>imap_stream</parameter> should be the value returned from - an <function>imap_open</function> call. NOTE: This stream is required - to be opened as the mail admin user for the get_quota function to work. - <parameter>quota_root</parameter> should normally be in the form of - user.name where name is the mailbox you wish to retrieve information - about. - </para> - <para> - <example> - <title><function>imap_get_quota</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.16 $ --> +<refentry id="function.imap-get-quota"> + <refnamediv> + <refname>imap_get_quota</refname> + <refpurpose>Retrieve the quota level settings, and usage statics per mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_get_quota</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> + </methodsynopsis> + <para> + Returns an array with integer values limit and usage for the given + mailbox. The value of limit represents the total amount of space + allowed for this mailbox. The usage value represents the mailboxes + current level of capacity. Will return &false; in the case of failure. + </para> + <para> + This function is currently only available to users of the c-client2000 + or greater library. + </para> + <para> + NOTE: For this function to work, the mail stream is required to be opened + as the mail-admin user. For a non-admin user version of this function, + please see the <function>imap_get_quotaroot</function> function of PHP. + </para> + <para> + <parameter>imap_stream</parameter> should be the value returned from + an <function>imap_open</function> call. NOTE: This stream is required + to be opened as the mail admin user for the get_quota function to work. + <parameter>quota_root</parameter> should normally be in the form of + user.name where name is the mailbox you wish to retrieve information + about. + </para> + <para> + <example> + <title><function>imap_get_quota</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN) or die("can't connect: " . imap_last_error()); - + $quota_value = imap_get_quota($mbox, "user.kalowsky"); if (is_array($quota_value)) { echo "Usage level is: " . $quota_value['usage']; echo "Limit level is: " . $quota_value['limit']; -} - -imap_close($mbox); +} + +imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - <para> - As of PHP 4.3, the function more properly reflects the - functionality as dictated by the <ulink url="&url.rfc;2087">RFC2087</ulink>. - The array return value has changed to support an unlimited number of returned resources (i.e. - messages, or sub-folders) with each named resource receiving an individual - array key. Each key value then contains an another array with the usage - and limit values within it. The example below shows the updated returned - output. - </para> - <para> - For backwards compatibility reasons, the original access methods are - still available for use, although it is suggested to update. - </para> - <para> - <example> - <title><function>imap_get_quota</function> 4.3 or greater - example</title> - <programlisting role="php"> + </programlisting> + </example> + </para> + <para> + As of PHP 4.3, the function more properly reflects the + functionality as dictated by the <ulink url="&url.rfc;2087">RFC2087</ulink>. + The array return value has changed to support an unlimited number of returned resources (i.e. + messages, or sub-folders) with each named resource receiving an individual + array key. Each key value then contains an another array with the usage + and limit values within it. The example below shows the updated returned + output. + </para> + <para> + For backwards compatibility reasons, the original access methods are + still available for use, although it is suggested to update. + </para> + <para> + <example> + <title><function>imap_get_quota</function> 4.3 or greater + example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN) or die("can't connect: " . imap_last_error()); - + $quota_values = imap_get_quota($mbox, "user.kalowsky"); if (is_array($quota_values)) { $storage = $quota_values['STORAGE']; echo "STORAGE usage level is: " . $storage['usage']; echo "STORAGE limit level is: " . $storage['limit']; - $message = $quota_values['MESSAGE']; + $message = $quota_values['MESSAGE']; echo "MESSAGE usage level is: " . $message['usage']; echo "MESSAGE limit is: " . $message['limit']; - /* ... */ -} + /* ... */ +} -imap_close($mbox); +imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>imap_open</function>, - <function>imap_set_quota</function> and - <function>imap_get_quotaroot</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>imap_open</function>, + <function>imap_set_quota</function> and + <function>imap_get_quotaroot</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml diff -u phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml:1.6 phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml:1.6 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-get-quotaroot.xml Sun Jan 14 15:37:21 2007 @@ -1,78 +1,76 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <refentry id="function.imap-get-quotaroot"> - <refnamediv> - <refname>imap_get_quotaroot</refname> - <refpurpose> - Retrieve the quota settings per user - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_get_quotaroot</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> - </methodsynopsis> - <para> - Returns an array of integer values pertaining to the specified user - mailbox. All values contain a key based upon the resource name, and a - corresponding array with the usage and limit values within. - </para> - <para> - The limit value represents the total amount of space - allowed for this user's total mailbox usage. The usage value represents - the user's current total mailbox capacity. This function will return - &false; in the case of call failure, and an array of information about - the connection upon an un-parsable response from the server. - </para> - <para> - This function is currently only available to users of the c-client2000 - or greater library. - </para> - <para> - <parameter>imap_stream</parameter> should be the value returned from - an <function>imap_open</function> call. This stream should be opened - as the user whose mailbox you wish to check. - <parameter>quota_root</parameter> should normally be in the form of - which mailbox (i.e. INBOX). - </para> - <para> - <example> - <title><function>imap_get_quotaroot</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.7 $ --> +<refentry id="function.imap-get-quotaroot"> + <refnamediv> + <refname>imap_get_quotaroot</refname> + <refpurpose>Retrieve the quota settings per user</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_get_quotaroot</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> + </methodsynopsis> + <para> + Returns an array of integer values pertaining to the specified user + mailbox. All values contain a key based upon the resource name, and a + corresponding array with the usage and limit values within. + </para> + <para> + The limit value represents the total amount of space + allowed for this user's total mailbox usage. The usage value represents + the user's current total mailbox capacity. This function will return + &false; in the case of call failure, and an array of information about + the connection upon an un-parsable response from the server. + </para> + <para> + This function is currently only available to users of the c-client2000 + or greater library. + </para> + <para> + <parameter>imap_stream</parameter> should be the value returned from + an <function>imap_open</function> call. This stream should be opened + as the user whose mailbox you wish to check. + <parameter>quota_root</parameter> should normally be in the form of + which mailbox (i.e. INBOX). + </para> + <para> + <example> + <title><function>imap_get_quotaroot</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org}", "kalowsky", "password", OP_HALFOPEN) or die("can't connect: " . imap_last_error()); - + $quota = imap_get_quotaroot($mbox, "INBOX"); if (is_array($quota)) { $storage = $quota_values['STORAGE']; echo "STORAGE usage level is: " . $storage['usage']; echo "STORAGE limit level is: " . $storage['limit']; - $message = $quota_values['MESSAGE']; + $message = $quota_values['MESSAGE']; echo "MESSAGE usage level is: " . $message['usage']; echo "MESSAGE usage level is: " . $message['limit']; - /* ... */ + /* ... */ + +} -} - -imap_close($mbox); +imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>imap_open</function>, - <function>imap_set_quota</function> and - <function>imap_get_quota</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>imap_open</function>, + <function>imap_set_quota</function> and + <function>imap_get_quota</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-getacl.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-getacl.xml diff -u phpdoc/en/reference/imap/functions/imap-getacl.xml:1.3 phpdoc/en/reference/imap/functions/imap-getacl.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-getacl.xml:1.3 Tue Aug 31 01:20:59 2004 +++ phpdoc/en/reference/imap/functions/imap-getacl.xml Sun Jan 14 15:37:21 2007 @@ -1,30 +1,28 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> - <refentry id="function.imap-getacl"> - <refnamediv> - <refname>imap_getacl</refname> - <refpurpose> - Gets the ACL for a given mailbox - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_getacl</methodname> - <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> - </methodsynopsis> +<!-- $Revision: 1.4 $ --> +<refentry id="function.imap-getacl"> + <refnamediv> + <refname>imap_getacl</refname> + <refpurpose>Gets the ACL for a given mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_getacl</methodname> + <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; - <para> - This function is currently only available to users of the c-client2000 - or greater library. - </para> - <para> - See also <function>imap_setacl</function>. - </para> - </refsect1> - </refentry> + &warn.undocumented.func; + <para> + This function is currently only available to users of the c-client2000 + or greater library. + </para> + <para> + See also <function>imap_setacl</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-getmailboxes.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-getmailboxes.xml diff -u phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.8 phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-getmailboxes.xml:1.8 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-getmailboxes.xml Sun Jan 14 15:37:21 2007 @@ -1,89 +1,85 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-getmailboxes"> - <refnamediv> - <refname>imap_getmailboxes</refname> - <refpurpose> - Read the list of mailboxes, returning detailed information on - each one - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_getmailboxes</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>ref</parameter></methodparam> - <methodparam><type>string</type><parameter>pattern</parameter></methodparam> - </methodsynopsis> - <para> - Returns an array of objects containing mailbox information. Each - object has the attributes <parameter>name</parameter>, specifying - the full name of the mailbox; <parameter>delimiter</parameter>, - which is the hierarchy delimiter for the part of the hierarchy - this mailbox is in; and - <parameter>attributes</parameter>. <parameter>Attributes</parameter> - is a bitmask that can be tested against: - <itemizedlist> - <listitem> - <simpara> - <constant>LATT_NOINFERIORS</constant> - This mailbox has no - "children" (there are no mailboxes below this one). - </simpara> - </listitem> - <listitem> - <simpara> - <constant>LATT_NOSELECT</constant> - This is only a container, - not a mailbox - you cannot open it. - </simpara> - </listitem> - <listitem> - <simpara> - <constant>LATT_MARKED</constant> - This mailbox is marked. - Only used by UW-IMAPD. - </simpara> - </listitem> - <listitem> - <simpara> - <constant>LATT_UNMARKED</constant> - This mailbox is not marked. - Only used by UW-IMAPD. - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - Mailbox names containing international Characters outside the - printable ASCII range will be encoded and may be decoded by - <function>imap_utf7_decode</function>. - </para> - <para> - <parameter>ref</parameter> should normally be just the server - specification as described in <function>imap_open</function>, and - <parameter>pattern</parameter> specifies where in the mailbox - hierarchy to start searching. If you want all mailboxes, pass - '*' for <parameter>pattern</parameter>. - </para> - <para> - There are two special characters you can pass as part of the - <parameter>pattern</parameter>: '*' and '%'. '*' means to return - all mailboxes. If you pass <parameter>pattern</parameter> as '*', - you will get a list of the entire mailbox hierarchy. '%' means to - return the current level only. '%' as the - <parameter>pattern</parameter> parameter will return only the top - level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox - in the ~/mail directory, but none in subfolders of that - directory. - </para> - <para> - <example> - <title><function>imap_getmailboxes</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.9 $ --> +<refentry id="function.imap-getmailboxes"> + <refnamediv> + <refname>imap_getmailboxes</refname> + <refpurpose>Read the list of mailboxes, returning detailed information on each one</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_getmailboxes</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>ref</parameter></methodparam> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + </methodsynopsis> + <para> + Returns an array of objects containing mailbox information. Each + object has the attributes <parameter>name</parameter>, specifying + the full name of the mailbox; <parameter>delimiter</parameter>, + which is the hierarchy delimiter for the part of the hierarchy + this mailbox is in; and + <parameter>attributes</parameter>. <parameter>Attributes</parameter> + is a bitmask that can be tested against: + <itemizedlist> + <listitem> + <simpara> + <constant>LATT_NOINFERIORS</constant> - This mailbox has no + "children" (there are no mailboxes below this one). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LATT_NOSELECT</constant> - This is only a container, + not a mailbox - you cannot open it. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LATT_MARKED</constant> - This mailbox is marked. + Only used by UW-IMAPD. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LATT_UNMARKED</constant> - This mailbox is not marked. + Only used by UW-IMAPD. + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + Mailbox names containing international Characters outside the + printable ASCII range will be encoded and may be decoded by + <function>imap_utf7_decode</function>. + </para> + <para> + <parameter>ref</parameter> should normally be just the server + specification as described in <function>imap_open</function>, and + <parameter>pattern</parameter> specifies where in the mailbox + hierarchy to start searching. If you want all mailboxes, pass + '*' for <parameter>pattern</parameter>. + </para> + <para> + There are two special characters you can pass as part of the + <parameter>pattern</parameter>: '*' and '%'. '*' means to return + all mailboxes. If you pass <parameter>pattern</parameter> as '*', + you will get a list of the entire mailbox hierarchy. '%' means to + return the current level only. '%' as the + <parameter>pattern</parameter> parameter will return only the top + level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox + in the ~/mail directory, but none in subfolders of that + directory. + </para> + <para> + <example> + <title><function>imap_getmailboxes</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN) or die("can't connect: " . imap_last_error()); - + $list = imap_getmailboxes($mbox, "{imap.example.org}", "*"); if (is_array($list)) { foreach ($list as $key => $val) { @@ -95,18 +91,18 @@ } else { echo "imap_getmailboxes failed: " . imap_last_error() . "\n"; } - + imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>imap_getsubscribed</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>imap_getsubscribed</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-getsubscribed.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-getsubscribed.xml diff -u phpdoc/en/reference/imap/functions/imap-getsubscribed.xml:1.3 phpdoc/en/reference/imap/functions/imap-getsubscribed.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-getsubscribed.xml:1.3 Wed Oct 9 14:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-getsubscribed.xml Sun Jan 14 15:37:21 2007 @@ -1,26 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-getsubscribed"> - <refnamediv> - <refname>imap_getsubscribed</refname> - <refpurpose>List all the subscribed mailboxes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_getsubscribed</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>ref</parameter></methodparam> - <methodparam><type>string</type><parameter>pattern</parameter></methodparam> - </methodsynopsis> - <para> - This function is identical to - <function>imap_getmailboxes</function>, except that it only - returns mailboxes that the user is subscribed to. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id="function.imap-getsubscribed"> + <refnamediv> + <refname>imap_getsubscribed</refname> + <refpurpose>List all the subscribed mailboxes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_getsubscribed</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>ref</parameter></methodparam> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + </methodsynopsis> + <para> + This function is identical to + <function>imap_getmailboxes</function>, except that it only + returns mailboxes that the user is subscribed to. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-header.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-header.xml diff -u phpdoc/en/reference/imap/functions/imap-header.xml:1.5 phpdoc/en/reference/imap/functions/imap-header.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-header.xml:1.5 Mon Apr 25 16:17:01 2005 +++ phpdoc/en/reference/imap/functions/imap-header.xml Sun Jan 14 15:37:21 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imap-header"> <refnamediv> <refname>imap_header</refname> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-headerinfo.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-headerinfo.xml diff -u phpdoc/en/reference/imap/functions/imap-headerinfo.xml:1.3 phpdoc/en/reference/imap/functions/imap-headerinfo.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-headerinfo.xml:1.3 Wed Oct 9 14:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-headerinfo.xml Sun Jan 14 15:37:21 2007 @@ -1,44 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-headerinfo"> - <refnamediv> - <refname>imap_headerinfo</refname> - <refpurpose>Read the header of the message</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>imap_headerinfo</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>fromlength</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>subjectlength</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam> - </methodsynopsis> - <para> - This function returns an object of various header elements. - </para> - <para> - <informalexample> - <literallayout> - remail, date, Date, subject, Subject, in_reply_to, message_id, - newsgroups, followup_to, references +<!-- $Revision: 1.4 $ --> +<refentry id="function.imap-headerinfo"> + <refnamediv> + <refname>imap_headerinfo</refname> + <refpurpose>Read the header of the message</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>imap_headerinfo</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>fromlength</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>subjectlength</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam> + </methodsynopsis> + <para> + This function returns an object of various header elements. + </para> + <para> + <informalexample> + <literallayout> + remail, date, Date, subject, Subject, in_reply_to, message_id, + newsgroups, followup_to, references message flags: - Recent - 'R' if recent and seen, - 'N' if recent and not seen, - ' ' if not recent - Unseen - 'U' if not seen AND not recent, - ' ' if seen OR not seen and recent - Answered -'A' if answered, - ' ' if unanswered - Deleted - 'D' if deleted, - ' ' if not deleted - Draft - 'X' if draft, - ' ' if not draft - Flagged - 'F' if flagged, - ' ' if not flagged + Recent - 'R' if recent and seen, + 'N' if recent and not seen, + ' ' if not recent + Unseen - 'U' if not seen AND not recent, + ' ' if seen OR not seen and recent + Answered -'A' if answered, + ' ' if unanswered + Deleted - 'D' if deleted, + ' ' if not deleted + Draft - 'X' if draft, + ' ' if not draft + Flagged - 'F' if flagged, + ' ' if not flagged NOTE that the Recent/Unseen behavior is a little odd. If you want to know if a message is Unseen, you must check for @@ -48,67 +47,67 @@ toaddress (full to: line, up to 1024 characters) to[] (returns an array of objects from the To line, containing): - personal - adl - mailbox - host + personal + adl + mailbox + host fromaddress (full from: line, up to 1024 characters) from[] (returns an array of objects from the From line, containing): - personal - adl - mailbox - host + personal + adl + mailbox + host ccaddress (full cc: line, up to 1024 characters) cc[] (returns an array of objects from the Cc line, containing): - personal - adl - mailbox - host + personal + adl + mailbox + host bccaddress (full bcc line, up to 1024 characters) bcc[] (returns an array of objects from the Bcc line, containing): - personal - adl - mailbox - host + personal + adl + mailbox + host reply_toaddress (full reply_to: line, up to 1024 characters) reply_to[] (returns an array of objects from the Reply_to line, containing): - personal - adl - mailbox - host + personal + adl + mailbox + host senderaddress (full sender: line, up to 1024 characters) sender[] (returns an array of objects from the sender line, containing): - personal - adl - mailbox - host + personal + adl + mailbox + host return_path (full return-path: line, up to 1024 characters) return_path[] (returns an array of objects from the return_path line, containing): - personal - adl - mailbox - host + personal + adl + mailbox + host udate (mail message date in unix time) -fetchfrom (from line formatted to fit <parameter>fromlength</parameter> +fetchfrom (from line formatted to fit <parameter>fromlength</parameter> characters) fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter> characters) - </literallayout> - </informalexample> - </para> - </refsect1> - </refentry> + </literallayout> + </informalexample> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-headers.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-headers.xml diff -u phpdoc/en/reference/imap/functions/imap-headers.xml:1.3 phpdoc/en/reference/imap/functions/imap-headers.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-headers.xml:1.3 Wed Oct 9 14:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-headers.xml Sun Jan 14 15:37:21 2007 @@ -1,25 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-headers"> - <refnamediv> - <refname>imap_headers</refname> - <refpurpose> - Returns headers for all messages in a mailbox - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_headers</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - </methodsynopsis> - <para> - Returns an array of string formatted with header info. One - element per mail message. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id="function.imap-headers"> + <refnamediv> + <refname>imap_headers</refname> + <refpurpose>Returns headers for all messages in a mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_headers</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> + <para> + Returns an array of string formatted with header info. One + element per mail message. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-last-error.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-last-error.xml diff -u phpdoc/en/reference/imap/functions/imap-last-error.xml:1.4 phpdoc/en/reference/imap/functions/imap-last-error.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-last-error.xml:1.4 Sun Feb 12 18:57:46 2006 +++ phpdoc/en/reference/imap/functions/imap-last-error.xml Sun Jan 14 15:37:21 2007 @@ -1,32 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-last-error"> - <refnamediv> - <refname>imap_last_error</refname> - <refpurpose> - This function returns the last IMAP error (if any) that occurred - during this page request - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>imap_last_error</methodname> - <void/> - </methodsynopsis> - <para> - This function returns the full text of the last IMAP error - message that occurred on the current page. The error stack is - untouched; calling <function>imap_last_error</function> - subsequently, with no intervening errors, will return the same - error. Returns &false; if no error messages are available. - </para> - <para> - See also: <function>imap_errors</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.imap-last-error"> + <refnamediv> + <refname>imap_last_error</refname> + <refpurpose>This function returns the last IMAP error (if any) that occurred during this page request</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>imap_last_error</methodname> + <void/> + </methodsynopsis> + <para> + This function returns the full text of the last IMAP error + message that occurred on the current page. The error stack is + untouched; calling <function>imap_last_error</function> + subsequently, with no intervening errors, will return the same + error. Returns &false; if no error messages are available. + </para> + <para> + See also: <function>imap_errors</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-list.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-list.xml diff -u phpdoc/en/reference/imap/functions/imap-list.xml:1.6 phpdoc/en/reference/imap/functions/imap-list.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-list.xml:1.6 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-list.xml Sun Jan 14 15:37:21 2007 @@ -1,32 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <refentry id="function.imap-list"> - <refnamediv> - <refname>imap_list</refname> - <refpurpose>Read the list of mailboxes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_list</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>ref</parameter></methodparam> - <methodparam><type>string</type><parameter>pattern</parameter></methodparam> - </methodsynopsis> - <para> - Returns an array containing the names of the mailboxes. - See <function>imap_getmailboxes</function> for a description - of <parameter>ref</parameter> and <parameter>pattern</parameter>. - </para> - <para> - <example> - <title><function>imap_list</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.7 $ --> +<refentry id="function.imap-list"> + <refnamediv> + <refname>imap_list</refname> + <refpurpose>Read the list of mailboxes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_list</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>ref</parameter></methodparam> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + </methodsynopsis> + <para> + Returns an array containing the names of the mailboxes. + See <function>imap_getmailboxes</function> for a description + of <parameter>ref</parameter> and <parameter>pattern</parameter>. + </para> + <para> + <example> + <title><function>imap_list</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN) or die("can't connect: " . imap_last_error()); - + $list = imap_list($mbox, "{imap.example.org}", "*"); if (is_array($list)) { foreach ($list as $val) { @@ -39,14 +39,14 @@ imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also: <function>imap_getmailboxes</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also: <function>imap_getmailboxes</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-listmailbox.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-listmailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-listmailbox.xml:1.5 phpdoc/en/reference/imap/functions/imap-listmailbox.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-listmailbox.xml:1.5 Mon Apr 25 16:17:01 2005 +++ phpdoc/en/reference/imap/functions/imap-listmailbox.xml Sun Jan 14 15:37:21 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imap-listmailbox"> <refnamediv> <refname>imap_listmailbox</refname> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-listscan.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-listscan.xml diff -u phpdoc/en/reference/imap/functions/imap-listscan.xml:1.2 phpdoc/en/reference/imap/functions/imap-listscan.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-listscan.xml:1.2 Mon Mar 8 09:18:42 2004 +++ phpdoc/en/reference/imap/functions/imap-listscan.xml Sun Jan 14 15:37:21 2007 @@ -1,37 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> - <refentry id="function.imap-listscan"> - <refnamediv> - <refname>imap_listscan</refname> - <refpurpose> - Read the list of mailboxes, takes a string to search for in the - text of the mailbox - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_listscan</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>ref</parameter></methodparam> - <methodparam><type>string</type><parameter>pattern</parameter></methodparam> - <methodparam><type>string</type><parameter>content</parameter></methodparam> - </methodsynopsis> - <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> - </refsect1> - </refentry> +<!-- $Revision: 1.3 $ --> +<refentry id="function.imap-listscan"> + <refnamediv> + <refname>imap_listscan</refname> + <refpurpose>Read the list of mailboxes, takes a string to search for in the text of the mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_listscan</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>ref</parameter></methodparam> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </methodsynopsis> + <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> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-listsubscribed.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-listsubscribed.xml diff -u phpdoc/en/reference/imap/functions/imap-listsubscribed.xml:1.5 phpdoc/en/reference/imap/functions/imap-listsubscribed.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-listsubscribed.xml:1.5 Mon Apr 25 16:17:01 2005 +++ phpdoc/en/reference/imap/functions/imap-listsubscribed.xml Sun Jan 14 15:37:21 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imap-listsubscribed"> <refnamediv> <refname>imap_listsubscribed</refname> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-lsub.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-lsub.xml diff -u phpdoc/en/reference/imap/functions/imap-lsub.xml:1.2 phpdoc/en/reference/imap/functions/imap-lsub.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-lsub.xml:1.2 Sat May 3 12:54:54 2003 +++ phpdoc/en/reference/imap/functions/imap-lsub.xml Sun Jan 14 15:37:21 2007 @@ -1,24 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> - <refentry id="function.imap-lsub"> - <refnamediv> - <refname>imap_lsub</refname> - <refpurpose>List all the subscribed mailboxes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_lsub</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>ref</parameter></methodparam> - <methodparam><type>string</type><parameter>pattern</parameter></methodparam> - </methodsynopsis> - <para> - Returns an array of all the mailboxes that you have - subscribed. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.3 $ --> +<refentry id="function.imap-lsub"> + <refnamediv> + <refname>imap_lsub</refname> + <refpurpose>List all the subscribed mailboxes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_lsub</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>ref</parameter></methodparam> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + </methodsynopsis> + <para> + Returns an array of all the mailboxes that you have + subscribed. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mail-compose.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mail-compose.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.6 phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-mail-compose.xml:1.6 Mon Mar 8 09:18:42 2004 +++ phpdoc/en/reference/imap/functions/imap-mail-compose.xml Sun Jan 14 15:37:21 2007 @@ -1,26 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-mail-compose"> - <refnamediv> - <refname>imap_mail_compose</refname> - <refpurpose> - Create a MIME message based on given envelope and body sections - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>imap_mail_compose</methodname> - <methodparam><type>array</type><parameter>envelope</parameter></methodparam> - <methodparam><type>array</type><parameter>body</parameter></methodparam> - </methodsynopsis> - <para> - </para> - <para> - <example> - <title><function>imap_mail_compose</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.7 $ --> +<refentry id="function.imap-mail-compose"> + <refnamediv> + <refname>imap_mail_compose</refname> + <refpurpose>Create a MIME message based on given envelope and body sections</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>imap_mail_compose</methodname> + <methodparam><type>array</type><parameter>envelope</parameter></methodparam> + <methodparam><type>array</type><parameter>body</parameter></methodparam> + </methodsynopsis> + <para> + </para> + <para> + <example> + <title><function>imap_mail_compose</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -55,11 +52,11 @@ ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mail-copy.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mail-copy.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.5 phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-mail-copy.xml:1.5 Mon Mar 8 09:18:42 2004 +++ phpdoc/en/reference/imap/functions/imap-mail-copy.xml Sun Jan 14 15:37:21 2007 @@ -1,49 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-mail-copy"> - <refnamediv> - <refname>imap_mail_copy</refname> - <refpurpose>Copy specified messages to a mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_mail_copy</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>msglist</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - Copies mail messages specified by <parameter>msglist</parameter> - 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> - <parameter>options</parameter> is a bitmask of one or more of - <itemizedlist> - <listitem> - <simpara> - <constant>CP_UID</constant> - the sequence numbers contain UIDS - </simpara> - </listitem> - <listitem> - <simpara> - <constant>CP_MOVE</constant> - Delete the messages from - the current mailbox after copying - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - See also <function>imap_mail_move</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.imap-mail-copy"> + <refnamediv> + <refname>imap_mail_copy</refname> + <refpurpose>Copy specified messages to a mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_mail_copy</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>msglist</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + Copies mail messages specified by <parameter>msglist</parameter> + 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> + <parameter>options</parameter> is a bitmask of one or more of + <itemizedlist> + <listitem> + <simpara> + <constant>CP_UID</constant> - the sequence numbers contain UIDS + </simpara> + </listitem> + <listitem> + <simpara> + <constant>CP_MOVE</constant> - Delete the messages from + the current mailbox after copying + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + See also <function>imap_mail_move</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mail-move.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mail-move.xml diff -u phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.6 phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-mail-move.xml:1.6 Mon Mar 8 09:18:42 2004 +++ phpdoc/en/reference/imap/functions/imap-mail-move.xml Sun Jan 14 15:37:21 2007 @@ -1,43 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-mail-move"> - <refnamediv> - <refname>imap_mail_move</refname> - <refpurpose>Move specified messages to a mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_mail_move</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>msglist</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - Moves mail messages specified by <parameter>msglist</parameter> - to specified mailbox <parameter>mbox</parameter>. &return.success;. - </para> - <para> - <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: - <itemizedlist> - <listitem> - <simpara> - <constant>CP_UID</constant> - the sequence numbers contain UIDS - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - See also <function>imap_mail_copy</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<refentry id="function.imap-mail-move"> + <refnamediv> + <refname>imap_mail_move</refname> + <refpurpose>Move specified messages to a mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_mail_move</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>msglist</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + Moves mail messages specified by <parameter>msglist</parameter> + to specified mailbox <parameter>mbox</parameter>. &return.success;. + </para> + <para> + <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: + <itemizedlist> + <listitem> + <simpara> + <constant>CP_UID</constant> - the sequence numbers contain UIDS + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + See also <function>imap_mail_copy</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mail.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mail.xml diff -u phpdoc/en/reference/imap/functions/imap-mail.xml:1.6 phpdoc/en/reference/imap/functions/imap-mail.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-mail.xml:1.6 Tue Sep 12 21:43:35 2006 +++ phpdoc/en/reference/imap/functions/imap-mail.xml Sun Jan 14 15:37:21 2007 @@ -1,44 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-mail"> - <refnamediv> - <refname>imap_mail</refname> - <refpurpose> - Send an email message - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_mail</methodname> - <methodparam><type>string</type><parameter>to</parameter></methodparam> - <methodparam><type>string</type><parameter>subject</parameter></methodparam> - <methodparam><type>string</type><parameter>message</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>additional_headers</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>cc</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>bcc</parameter></methodparam> - <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. &return.success;. - </para> - <para> - The parameters <parameter>to</parameter>, <parameter>cc</parameter> - and <parameter>bcc</parameter> are all strings and are all parsed - as <ulink url="&url.rfc;822">RFC822</ulink> address lists. - </para> - <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> +<!-- $Revision: 1.7 $ --> +<refentry id="function.imap-mail"> + <refnamediv> + <refname>imap_mail</refname> + <refpurpose>Send an email message</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_mail</methodname> + <methodparam><type>string</type><parameter>to</parameter></methodparam> + <methodparam><type>string</type><parameter>subject</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>additional_headers</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cc</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>bcc</parameter></methodparam> + <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. &return.success;. + </para> + <para> + The parameters <parameter>to</parameter>, <parameter>cc</parameter> + and <parameter>bcc</parameter> are all strings and are all parsed + as <ulink url="&url.rfc;822">RFC822</ulink> address lists. + </para> + <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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml diff -u phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml:1.5 phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml:1.5 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-mailboxmsginfo.xml Sun Jan 14 15:37:21 2007 @@ -1,82 +1,81 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-mailboxmsginfo"> - <refnamediv> - <refname>imap_mailboxmsginfo</refname> - <refpurpose>Get information about the current mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>imap_mailboxmsginfo</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - </methodsynopsis> - <para> - Returns information about the current mailbox. Returns &false; on - failure. - </para> - <para> - The <function>imap_mailboxmsginfo</function> function checks the - current mailbox status on the server. It is similar to - <function>imap_status</function>, but will additionally sum up the - size of all messages in the mailbox, which will take some additional - time to execute. It returns the information - in an object with following properties. - </para> - <para> - <table> - <title>Mailbox properties</title> - <tgroup cols="2"> - <tbody> - <row> - <entry>Date</entry> - <entry>date of last change</entry> - </row> - <row> - <entry>Driver</entry> - <entry>driver</entry> - </row> - <row> - <entry>Mailbox</entry> - <entry>name of the mailbox</entry> - </row> - <row> - <entry>Nmsgs</entry> - <entry>number of messages</entry> - </row> - <row> - <entry>Recent</entry> - <entry>number of recent messages</entry> - </row> - <row> - <entry>Unread</entry> - <entry>number of unread messages</entry> - </row> - <row> - <entry>Deleted</entry> - <entry>number of deleted messages</entry> - </row> - <row> - <entry>Size</entry> - <entry>mailbox size</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - <example> - <title><function>imap_mailboxmsginfo</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.6 $ --> +<refentry id="function.imap-mailboxmsginfo"> + <refnamediv> + <refname>imap_mailboxmsginfo</refname> + <refpurpose>Get information about the current mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>imap_mailboxmsginfo</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> + <para> + Returns information about the current mailbox. Returns &false; on + failure. + </para> + <para> + The <function>imap_mailboxmsginfo</function> function checks the + current mailbox status on the server. It is similar to + <function>imap_status</function>, but will additionally sum up the + size of all messages in the mailbox, which will take some additional + time to execute. It returns the information + in an object with following properties. + </para> + <para> + <table> + <title>Mailbox properties</title> + <tgroup cols="2"> + <tbody> + <row> + <entry>Date</entry> + <entry>date of last change</entry> + </row> + <row> + <entry>Driver</entry> + <entry>driver</entry> + </row> + <row> + <entry>Mailbox</entry> + <entry>name of the mailbox</entry> + </row> + <row> + <entry>Nmsgs</entry> + <entry>number of messages</entry> + </row> + <row> + <entry>Recent</entry> + <entry>number of recent messages</entry> + </row> + <row> + <entry>Unread</entry> + <entry>number of unread messages</entry> + </row> + <row> + <entry>Deleted</entry> + <entry>number of deleted messages</entry> + </row> + <row> + <entry>Size</entry> + <entry>mailbox size</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + <example> + <title><function>imap_mailboxmsginfo</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org}INBOX", "username", "password") or die("can't connect: " . imap_last_error()); - + $check = imap_mailboxmsginfo($mbox); - + if ($check) { echo "Date: " . $check->Date . "<br />\n" ; echo "Driver: " . $check->Driver . "<br />\n" ; @@ -89,16 +88,16 @@ } else { echo "imap_check() failed: " . imap_last_error() . "<br />\n"; } - + imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml diff -u phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml:1.9 phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml:1.9 Wed Dec 14 12:56:58 2005 +++ phpdoc/en/reference/imap/functions/imap-mime-header-decode.xml Sun Jan 14 15:37:21 2007 @@ -1,31 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 --> - <refentry id="function.imap-mime-header-decode"> - <refnamediv> - <refname>imap_mime_header_decode</refname> - <refpurpose>Decode MIME header elements</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_mime_header_decode</methodname> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - </methodsynopsis> - <para> - <function>imap_mime_header_decode</function> function decodes - MIME message header extensions that are non ASCII text - (see <ulink url="&url.rfc;2047">RFC2047</ulink>). - The decoded elements are returned in an array of objects, - where each object has two properties, "charset" and "text". - 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". - </para> - <para> - <example> - <title><function>imap_mime_header_decode</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.10 $ --> +<refentry id="function.imap-mime-header-decode"> + <refnamediv> + <refname>imap_mime_header_decode</refname> + <refpurpose>Decode MIME header elements</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_mime_header_decode</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> + <para> + <function>imap_mime_header_decode</function> function decodes + MIME message header extensions that are non ASCII text + (see <ulink url="&url.rfc;2047">RFC2047</ulink>). + The decoded elements are returned in an array of objects, + where each object has two properties, "charset" and "text". + 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". + </para> + <para> + <example> + <title><function>imap_mime_header_decode</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $text = "=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= <keld@example.com>"; @@ -37,19 +36,19 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - In the above example we would have two elements, whereas the first - element had previously been encoded with ISO-8859-1, and the second - element would be plain US-ASCII. - </para> - <para> - See also <function>imap_utf8</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + In the above example we would have two elements, whereas the first + element had previously been encoded with ISO-8859-1, and the second + element would be plain US-ASCII. + </para> + <para> + See also <function>imap_utf8</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-msgno.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-msgno.xml diff -u phpdoc/en/reference/imap/functions/imap-msgno.xml:1.4 phpdoc/en/reference/imap/functions/imap-msgno.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-msgno.xml:1.4 Mon Mar 8 09:18:42 2004 +++ phpdoc/en/reference/imap/functions/imap-msgno.xml Sun Jan 14 15:37:21 2007 @@ -1,31 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-msgno"> - <refnamediv> - <refname>imap_msgno</refname> - <refpurpose> - This function returns the message sequence number for the given - UID - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>imap_msgno</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>uid</parameter></methodparam> - </methodsynopsis> - <para> - This function returns the message sequence number for the given - <parameter>uid</parameter>. It is the inverse of - <function>imap_uid</function>. - </para> - <para> - See also <function>imap_uid</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.imap-msgno"> + <refnamediv> + <refname>imap_msgno</refname> + <refpurpose>This function returns the message sequence number for the given UID</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>imap_msgno</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>uid</parameter></methodparam> + </methodsynopsis> + <para> + This function returns the message sequence number for the given + <parameter>uid</parameter>. It is the inverse of + <function>imap_uid</function>. + </para> + <para> + See also <function>imap_uid</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-num-msg.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-num-msg.xml diff -u phpdoc/en/reference/imap/functions/imap-num-msg.xml:1.3 phpdoc/en/reference/imap/functions/imap-num-msg.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-num-msg.xml:1.3 Wed Oct 9 14:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-num-msg.xml Sun Jan 14 15:37:21 2007 @@ -1,28 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>int</type><methodname>imap_num_msg</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - </methodsynopsis> - <para> - Return the number of messages in the current mailbox. - </para> - <para> - See also: <function>imap_num_recent</function> and - <function>imap_status</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<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> + <methodsynopsis> + <type>int</type><methodname>imap_num_msg</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> + <para> + Return the number of messages in the current mailbox. + </para> + <para> + See also: <function>imap_num_recent</function> and + <function>imap_status</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-num-recent.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-num-recent.xml diff -u phpdoc/en/reference/imap/functions/imap-num-recent.xml:1.3 phpdoc/en/reference/imap/functions/imap-num-recent.xml:1.4 --- phpdoc/en/reference/imap/functions/imap-num-recent.xml:1.3 Wed Oct 9 14:55:05 2002 +++ phpdoc/en/reference/imap/functions/imap-num-recent.xml Sun Jan 14 15:37:21 2007 @@ -1,27 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>int</type><methodname>imap_num_recent</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - </methodsynopsis> - <para> - Returns the number of recent messages in the current mailbox. - </para> - <para> - See also: <function>imap_num_msg</function> and - <function>imap_status</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<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> + <methodsynopsis> + <type>int</type><methodname>imap_num_recent</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> + <para> + Returns the number of recent messages in the current mailbox. + </para> + <para> + See also: <function>imap_num_msg</function> and + <function>imap_status</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-open.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-open.xml diff -u phpdoc/en/reference/imap/functions/imap-open.xml:1.10 phpdoc/en/reference/imap/functions/imap-open.xml:1.11 --- phpdoc/en/reference/imap/functions/imap-open.xml:1.10 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-open.xml Sun Jan 14 15:37:21 2007 @@ -1,217 +1,216 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-open"> - <refnamediv> - <refname>imap_open</refname> - <refpurpose>Open an IMAP stream to a mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>imap_open</methodname> - <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> - <methodparam><type>string</type><parameter>username</parameter></methodparam> - <methodparam><type>string</type><parameter>password</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - Returns an IMAP stream on success and &false; on error. This - function can also be used to open streams to POP3 and NNTP - servers, but some functions and features are only available - on IMAP servers. - </para> - <para> - A mailbox name consists of a server part and a mailbox path on - this server. The special name INBOX stands for the current users - personal mailbox. The server part, which is enclosed in '{' and - '}', consists of the servers name or ip address, an optional port - (prefixed by ':'), and an optional protocol specification (prefixed - by '/'). The server part is mandatory in all mailbox - parameters. Mailbox names that contain international characters - besides those in the printable ASCII space have to be encoded - with <function>imap_utf7_encode</function>. - </para> - <para> - All names which start with <literal>{</literal> are remote names, and are - in the form <literal>"{" remote_system_name [":" port] [flags] "}" - [mailbox_name]</literal> where: - <itemizedlist> - <listitem> - <simpara> - <literal>remote_system_name</literal> - Internet domain name or - bracketed IP address of server. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>port</literal> - optional TCP port number, default is the - default port for that service - </simpara> - </listitem> - <listitem> - <simpara> - <literal>flags</literal> - optional flags, see following table. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>mailbox_name</literal> - remote mailbox name, default is INBOX - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - <table> - <title>Optional flags for names</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Flag</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>/service=</literal><emphasis>service</emphasis></entry> - <entry>mailbox access service, default is "imap"</entry> - </row> - <row> - <entry><literal>/user=</literal><emphasis>user</emphasis></entry> - <entry>remote user name for login on the server</entry> - </row> - <row> - <entry><literal>/authuser=</literal><emphasis>user</emphasis></entry> - <entry>remote authentication user; if specified this is the user name - whose password is used (e.g. administrator)</entry> - </row> - <row> - <entry><literal>/anonymous</literal></entry> - <entry>remote access as anonymous user</entry> - </row> - <row> - <entry><literal>/debug</literal></entry> - <entry>record protocol telemetry in application's debug log</entry> - </row> - <row> - <entry><literal>/secure</literal></entry> - <entry>do not transmit a plaintext password over the network</entry> - </row> - <row> - <entry><literal>/imap</literal>, <literal>/imap2</literal>, - <literal>/imap2bis</literal>, <literal>/imap4</literal>, - <literal>/imap4rev1</literal></entry> - <entry>equivalent to /service=imap</entry> - </row> - <row> - <entry><literal>/pop3</literal></entry> - <entry>equivalent to /service=pop3</entry> - </row> - <row> - <entry><literal>/nntp</literal></entry> - <entry>equivalent to /service=nntp</entry> - </row> - <row> - <entry><literal>/norsh</literal></entry> - <entry>do not use rsh or ssh to establish a preauthenticated IMAP - session</entry> - </row> - <row> - <entry><literal>/ssl</literal></entry> - <entry>use the Secure Socket Layer to encrypt the session</entry> - </row> - <row> - <entry><literal>/validate-cert</literal></entry> - <entry>validate certificates from TLS/SSL server (this is the default - behavior)</entry> - </row> - <row> - <entry><literal>/novalidate-cert</literal></entry> - <entry>do not validate certificates from TLS/SSL server, needed if - server uses self-signed certificates</entry> - </row> - <row> - <entry><literal>/tls</literal></entry> - <entry>force use of start-TLS to encrypt the session, and reject - connection to servers that do not support it</entry> - </row> - <row> - <entry><literal>/notls</literal></entry> - <entry>do not do start-TLS to encrypt the session, even with servers - that support it</entry> - </row> - <row> - <entry><literal>/readonly</literal></entry> - <entry>request read-only mailbox open (IMAP only; ignored on NNTP, and - an error with SMTP and POP3)</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - The <parameter>options</parameter> are a bit mask with one or more of the following: - <itemizedlist> - <listitem> - <simpara> - <constant>OP_READONLY</constant> - Open mailbox read-only - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_ANONYMOUS</constant> - Don't use or update a - <filename>.newsrc</filename> for news (NNTP only) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but - don't open a mailbox. - </simpara> - </listitem> - <listitem> - <simpara> - <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close - (see also <function>imap_delete</function> and - <function>imap_expunge</function>) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_DEBUG</constant> - Debug protocol negotiations - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_SHORTCACHE</constant> - Short (elt-only) caching - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_SILENT</constant> - Don't pass up events (internal use) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_PROTOTYPE</constant> - Return driver prototype - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_EXPUNGE</constant> - Silently expunge recycle stream - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_SECURE</constant> - Don't do non-secure authentication - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - <example> - <title>Different use of <function>imap_open</function></title> - <programlisting role="php"> +<!-- $Revision: 1.11 $ --> +<refentry id="function.imap-open"> + <refnamediv> + <refname>imap_open</refname> + <refpurpose>Open an IMAP stream to a mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>imap_open</methodname> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + Returns an IMAP stream on success and &false; on error. This + function can also be used to open streams to POP3 and NNTP + servers, but some functions and features are only available + on IMAP servers. + </para> + <para> + A mailbox name consists of a server part and a mailbox path on + this server. The special name INBOX stands for the current users + personal mailbox. The server part, which is enclosed in '{' and + '}', consists of the servers name or ip address, an optional port + (prefixed by ':'), and an optional protocol specification (prefixed + by '/'). The server part is mandatory in all mailbox + parameters. Mailbox names that contain international characters + besides those in the printable ASCII space have to be encoded + with <function>imap_utf7_encode</function>. + </para> + <para> + All names which start with <literal>{</literal> are remote names, and are + in the form <literal>"{" remote_system_name [":" port] [flags] "}" + [mailbox_name]</literal> where: + <itemizedlist> + <listitem> + <simpara> + <literal>remote_system_name</literal> - Internet domain name or + bracketed IP address of server. + </simpara> + </listitem> + <listitem> + <simpara> + <literal>port</literal> - optional TCP port number, default is the + default port for that service + </simpara> + </listitem> + <listitem> + <simpara> + <literal>flags</literal> - optional flags, see following table. + </simpara> + </listitem> + <listitem> + <simpara> + <literal>mailbox_name</literal> - remote mailbox name, default is INBOX + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + <table> + <title>Optional flags for names</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Flag</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>/service=</literal><emphasis>service</emphasis></entry> + <entry>mailbox access service, default is "imap"</entry> + </row> + <row> + <entry><literal>/user=</literal><emphasis>user</emphasis></entry> + <entry>remote user name for login on the server</entry> + </row> + <row> + <entry><literal>/authuser=</literal><emphasis>user</emphasis></entry> + <entry>remote authentication user; if specified this is the user name + whose password is used (e.g. administrator)</entry> + </row> + <row> + <entry><literal>/anonymous</literal></entry> + <entry>remote access as anonymous user</entry> + </row> + <row> + <entry><literal>/debug</literal></entry> + <entry>record protocol telemetry in application's debug log</entry> + </row> + <row> + <entry><literal>/secure</literal></entry> + <entry>do not transmit a plaintext password over the network</entry> + </row> + <row> + <entry><literal>/imap</literal>, <literal>/imap2</literal>, + <literal>/imap2bis</literal>, <literal>/imap4</literal>, + <literal>/imap4rev1</literal></entry> + <entry>equivalent to /service=imap</entry> + </row> + <row> + <entry><literal>/pop3</literal></entry> + <entry>equivalent to /service=pop3</entry> + </row> + <row> + <entry><literal>/nntp</literal></entry> + <entry>equivalent to /service=nntp</entry> + </row> + <row> + <entry><literal>/norsh</literal></entry> + <entry>do not use rsh or ssh to establish a preauthenticated IMAP + session</entry> + </row> + <row> + <entry><literal>/ssl</literal></entry> + <entry>use the Secure Socket Layer to encrypt the session</entry> + </row> + <row> + <entry><literal>/validate-cert</literal></entry> + <entry>validate certificates from TLS/SSL server (this is the default + behavior)</entry> + </row> + <row> + <entry><literal>/novalidate-cert</literal></entry> + <entry>do not validate certificates from TLS/SSL server, needed if + server uses self-signed certificates</entry> + </row> + <row> + <entry><literal>/tls</literal></entry> + <entry>force use of start-TLS to encrypt the session, and reject + connection to servers that do not support it</entry> + </row> + <row> + <entry><literal>/notls</literal></entry> + <entry>do not do start-TLS to encrypt the session, even with servers + that support it</entry> + </row> + <row> + <entry><literal>/readonly</literal></entry> + <entry>request read-only mailbox open (IMAP only; ignored on NNTP, and + an error with SMTP and POP3)</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + The <parameter>options</parameter> are a bit mask with one or more of the following: + <itemizedlist> + <listitem> + <simpara> + <constant>OP_READONLY</constant> - Open mailbox read-only + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_ANONYMOUS</constant> - Don't use or update a + <filename>.newsrc</filename> for news (NNTP only) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but + don't open a mailbox. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close + (see also <function>imap_delete</function> and + <function>imap_expunge</function>) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_DEBUG</constant> - Debug protocol negotiations + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_SHORTCACHE</constant> - Short (elt-only) caching + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_SILENT</constant> - Don't pass up events (internal use) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_PROTOTYPE</constant> - Return driver prototype + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_EXPUNGE</constant> - Silently expunge recycle stream + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_SECURE</constant> - Don't do non-secure authentication + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + <example> + <title>Different use of <function>imap_open</function></title> + <programlisting role="php"> <![CDATA[ <?php // To connect to an IMAP server running on port 143 on the local machine, @@ -235,13 +234,13 @@ // IP address of the server you want to connect to. ?> ]]> - </programlisting> - </example> - </para> - <para> - <example> - <title><function>imap_open</function> example</title> - <programlisting role="php"> + </programlisting> + </example> + </para> + <para> + <example> + <title><function>imap_open</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org:143}", "username", "password"); @@ -271,11 +270,11 @@ imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-ping.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-ping.xml diff -u phpdoc/en/reference/imap/functions/imap-ping.xml:1.6 phpdoc/en/reference/imap/functions/imap-ping.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-ping.xml:1.6 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-ping.xml Sun Jan 14 15:37:21 2007 @@ -1,30 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-ping"> - <refnamediv> - <refname>imap_ping</refname> - <refpurpose>Check if the IMAP stream is still active</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_ping</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - </methodsynopsis> - <para> - Returns &true; if the stream is still alive, &false; otherwise. - </para> - <para> - <function>imap_ping</function> pings the stream to see if it's still - active. It may discover new mail; this is the preferred method for a - periodic "new mail check" as well as a "keep alive" for servers which - have inactivity timeout. - </para> - <para> - <example> - <title><function>imap_ping</function> Example</title> - <programlisting role="php"> +<!-- $Revision: 1.7 $ --> +<refentry id="function.imap-ping"> + <refnamediv> + <refname>imap_ping</refname> + <refpurpose>Check if the IMAP stream is still active</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_ping</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> + <para> + Returns &true; if the stream is still alive, &false; otherwise. + </para> + <para> + <function>imap_ping</function> pings the stream to see if it's still + active. It may discover new mail; this is the preferred method for a + periodic "new mail check" as well as a "keep alive" for servers which + have inactivity timeout. + </para> + <para> + <example> + <title><function>imap_ping</function> Example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -37,11 +36,11 @@ ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-qprint.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-qprint.xml diff -u phpdoc/en/reference/imap/functions/imap-qprint.xml:1.4 phpdoc/en/reference/imap/functions/imap-qprint.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-qprint.xml:1.4 Mon Mar 8 09:18:43 2004 +++ phpdoc/en/reference/imap/functions/imap-qprint.xml Sun Jan 14 15:37:21 2007 @@ -1,28 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>string</type><methodname>imap_qprint</methodname> - <methodparam><type>string</type><parameter>string</parameter></methodparam> - </methodsynopsis> - <para> - Convert a quoted-printable string to an 8 bit string (according - to <ulink url="&url.rfc;2045">RFC2045</ulink>, section - 6.7). - </para> - <para> - See also <function>imap_8bit</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<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> + <methodsynopsis> + <type>string</type><methodname>imap_qprint</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> + <para> + Convert a quoted-printable string to an 8 bit string (according + to <ulink url="&url.rfc;2045">RFC2045</ulink>, section + 6.7). + </para> + <para> + See also <function>imap_8bit</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-renamemailbox.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-renamemailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-renamemailbox.xml:1.4 phpdoc/en/reference/imap/functions/imap-renamemailbox.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-renamemailbox.xml:1.4 Thu Feb 6 03:11:20 2003 +++ phpdoc/en/reference/imap/functions/imap-renamemailbox.xml Sun Jan 14 15:37:21 2007 @@ -1,35 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-renamemailbox"> - <refnamediv> - <refname>imap_renamemailbox</refname> - <refpurpose>Rename an old mailbox to new mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_renamemailbox</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>old_mbox</parameter></methodparam> - <methodparam><type>string</type><parameter>new_mbox</parameter></methodparam> - </methodsynopsis> - <para> - This function renames on old mailbox to new mailbox (see - <function>imap_open</function> for the format of - <parameter>mbox</parameter> names). - </para> - <para> - &return.success; - </para> - <para> - See also <function>imap_createmailbox</function>, - <function>imap_deletemailbox</function>, and - <function>imap_open</function> for the format of - <parameter>mbox</parameter>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.imap-renamemailbox"> + <refnamediv> + <refname>imap_renamemailbox</refname> + <refpurpose>Rename an old mailbox to new mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_renamemailbox</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>old_mbox</parameter></methodparam> + <methodparam><type>string</type><parameter>new_mbox</parameter></methodparam> + </methodsynopsis> + <para> + This function renames on old mailbox to new mailbox (see + <function>imap_open</function> for the format of + <parameter>mbox</parameter> names). + </para> + <para> + &return.success; + </para> + <para> + See also <function>imap_createmailbox</function>, + <function>imap_deletemailbox</function>, and + <function>imap_open</function> for the format of + <parameter>mbox</parameter>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-reopen.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-reopen.xml diff -u phpdoc/en/reference/imap/functions/imap-reopen.xml:1.9 phpdoc/en/reference/imap/functions/imap-reopen.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-reopen.xml:1.9 Fri Jun 16 18:11:33 2006 +++ phpdoc/en/reference/imap/functions/imap-reopen.xml Sun Jan 14 15:37:21 2007 @@ -1,58 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-reopen"> - <refnamediv> - <refname>imap_reopen</refname> - <refpurpose>Reopen IMAP stream to new mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_reopen</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - This function reopens the specified stream to a new - <parameter>mailbox</parameter> on an IMAP or NNTP server. - </para> - <para> - The <parameter>options</parameter> are a bit mask with one or more of the following: - <itemizedlist> - <listitem> - <simpara> - <constant>OP_READONLY</constant> - Open mailbox read-only - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_ANONYMOUS</constant> - Don't use or update a - <filename>.newsrc</filename> for news (NNTP only) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but - don't open a mailbox. - </simpara> - </listitem> - <listitem> - <simpara> - <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close - (see also <function>imap_delete</function> and - <function>imap_expunge</function>) - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - &return.success; - </para> - <example> - <title><function>imap_reopen</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.10 $ --> +<refentry id="function.imap-reopen"> + <refnamediv> + <refname>imap_reopen</refname> + <refpurpose>Reopen IMAP stream to new mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_reopen</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + This function reopens the specified stream to a new + <parameter>mailbox</parameter> on an IMAP or NNTP server. + </para> + <para> + The <parameter>options</parameter> are a bit mask with one or more of the following: + <itemizedlist> + <listitem> + <simpara> + <constant>OP_READONLY</constant> - Open mailbox read-only + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_ANONYMOUS</constant> - Don't use or update a + <filename>.newsrc</filename> for news (NNTP only) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but + don't open a mailbox. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close + (see also <function>imap_delete</function> and + <function>imap_expunge</function>) + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + &return.success; + </para> + <example> + <title><function>imap_reopen</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org:143}INBOX", "username", "password") or die(implode(", ", imap_errors())); @@ -61,11 +60,11 @@ // .. ?> ]]> - </programlisting> - </example> - </refsect1> + </programlisting> + </example> + </refsect1> - </refentry> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml diff -u phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml:1.8 phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml:1.8 Mon Mar 8 09:18:43 2004 +++ phpdoc/en/reference/imap/functions/imap-rfc822-parse-adrlist.xml Sun Jan 14 15:37:21 2007 @@ -1,52 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>array</type><methodname>imap_rfc822_parse_adrlist</methodname> - <methodparam><type>string</type><parameter>address</parameter></methodparam> - <methodparam><type>string</type><parameter>default_host</parameter></methodparam> - </methodsynopsis> - <para> - This function parses the address string as defined in - <ulink url="&url.rfc;2822">RFC2822</ulink> and - for each address, returns an array of objects. - The objects properties are: - </para> - <para> - <itemizedlist> - <listitem> - <simpara> - mailbox - the mailbox name (username) - </simpara> - </listitem> - <listitem> - <simpara> - host - the host name - </simpara> - </listitem> - <listitem> - <simpara> - personal - the personal name - </simpara> - </listitem> - <listitem> - <simpara> - adl - at domain source route - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - <example> - <title><function>imap_rfc822_parse_adrlist</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.9 $ --> +<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> + <methodsynopsis> + <type>array</type><methodname>imap_rfc822_parse_adrlist</methodname> + <methodparam><type>string</type><parameter>address</parameter></methodparam> + <methodparam><type>string</type><parameter>default_host</parameter></methodparam> + </methodsynopsis> + <para> + This function parses the address string as defined in + <ulink url="&url.rfc;2822">RFC2822</ulink> and + for each address, returns an array of objects. + The objects properties are: + </para> + <para> + <itemizedlist> + <listitem> + <simpara> + mailbox - the mailbox name (username) + </simpara> + </listitem> + <listitem> + <simpara> + host - the host name + </simpara> + </listitem> + <listitem> + <simpara> + personal - the personal name + </simpara> + </listitem> + <listitem> + <simpara> + adl - at domain source route + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + <example> + <title><function>imap_rfc822_parse_adrlist</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -55,20 +54,20 @@ 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"; echo "host : " . $val->host . "<br />\n"; echo "personal: " . $val->personal . "<br />\n"; echo "adl : " . $val->adl . "<br />\n"; -} +} ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml diff -u phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml:1.2 phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml:1.3 --- phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml:1.2 Wed Apr 17 06:39:21 2002 +++ phpdoc/en/reference/imap/functions/imap-rfc822-parse-headers.xml Sun Jan 14 15:37:21 2007 @@ -1,25 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-rfc822-parse-headers"> - <refnamediv> - <refname>imap_rfc822_parse_headers</refname> - <refpurpose>Parse mail headers from a string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>imap_rfc822_parse_headers</methodname> - <methodparam><type>string</type><parameter>headers</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam> - </methodsynopsis> - <para> - This function returns an object of various header elements, - similar to <function>imap_header</function>, except without the - flags and other elements that come from the IMAP server. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.3 $ --> +<refentry id="function.imap-rfc822-parse-headers"> + <refnamediv> + <refname>imap_rfc822_parse_headers</refname> + <refpurpose>Parse mail headers from a string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>imap_rfc822_parse_headers</methodname> + <methodparam><type>string</type><parameter>headers</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam> + </methodsynopsis> + <para> + This function returns an object of various header elements, + similar to <function>imap_header</function>, except without the + flags and other elements that come from the IMAP server. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml diff -u phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml:1.8 phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml:1.8 Fri Aug 20 09:36:59 2004 +++ phpdoc/en/reference/imap/functions/imap-rfc822-write-address.xml Sun Jan 14 15:37:21 2007 @@ -1,42 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>string</type><methodname>imap_rfc822_write_address</methodname> - <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> - <methodparam><type>string</type><parameter>host</parameter></methodparam> - <methodparam><type>string</type><parameter>personal</parameter></methodparam> - </methodsynopsis> - <para> - Returns a properly formatted email address as defined in - <ulink url="&url.rfc;2822">RFC2822</ulink> - given the <parameter>mailbox</parameter>, <parameter>host</parameter>, - and <parameter>personal</parameter> info. - </para> - <para> - <example> - <title><function>imap_rfc822_write_address</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.9 $ --> +<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> + <methodsynopsis> + <type>string</type><methodname>imap_rfc822_write_address</methodname> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>string</type><parameter>personal</parameter></methodparam> + </methodsynopsis> + <para> + Returns a properly formatted email address as defined in + <ulink url="&url.rfc;2822">RFC2822</ulink> + given the <parameter>mailbox</parameter>, <parameter>host</parameter>, + and <parameter>personal</parameter> info. + </para> + <para> + <example> + <title><function>imap_rfc822_write_address</function> example</title> + <programlisting role="php"> <![CDATA[ <?php -echo imap_rfc822_write_address("hartmut", "cvs.php.net", "Hartmut Holzgraefe") . "\n"; +echo imap_rfc822_write_address("hartmut", "cvs.php.net", "Hartmut Holzgraefe") . "\n"; ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-scanmailbox.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-scanmailbox.xml diff -u phpdoc/en/reference/imap/functions/imap-scanmailbox.xml:1.5 phpdoc/en/reference/imap/functions/imap-scanmailbox.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-scanmailbox.xml:1.5 Mon Apr 25 16:17:01 2005 +++ phpdoc/en/reference/imap/functions/imap-scanmailbox.xml Sun Jan 14 15:37:21 2007 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imap-scanmailbox"> <refnamediv> <refname>imap_scanmailbox</refname> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-search.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-search.xml diff -u phpdoc/en/reference/imap/functions/imap-search.xml:1.7 phpdoc/en/reference/imap/functions/imap-search.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-search.xml:1.7 Tue Sep 12 21:43:35 2006 +++ phpdoc/en/reference/imap/functions/imap-search.xml Sun Jan 14 15:37:21 2007 @@ -1,170 +1,166 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-search"> - <refnamediv> - <refname>imap_search</refname> - <refpurpose> - This function returns an array of messages matching the given - search criteria - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_search</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>criteria</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> - </methodsynopsis> - <para> - This function performs a search on the mailbox currently opened - in the given imap stream. <parameter>criteria</parameter> is a - string, delimited by spaces, in which the following keywords are - allowed. Any multi-word arguments (e.g. FROM "joey smith") must be - quoted. - <itemizedlist> - <listitem> - <simpara> - ALL - return all messages matching the rest of the criteria - </simpara> - </listitem> - <listitem> - <simpara> - ANSWERED - match messages with the \\ANSWERED flag set - </simpara> - </listitem> - <listitem> - <simpara> - BCC "string" - match messages with "string" in the Bcc: field - </simpara> - </listitem> - <listitem> - <simpara> - BEFORE "date" - match messages with Date: before "date" - </simpara> - </listitem> - <listitem> - <simpara> - BODY "string" - match messages with "string" in the body of the message - </simpara> - </listitem> - <listitem> - <simpara> - CC "string" - match messages with "string" in the Cc: field - </simpara> - </listitem> - <listitem> - <simpara> - DELETED - match deleted messages - </simpara> - </listitem> - <listitem> - <simpara> - FLAGGED - match messages with the \\FLAGGED (sometimes - referred to as Important or Urgent) flag set - </simpara> - </listitem> - <listitem> - <simpara> - FROM "string" - match messages with "string" in the From: field - </simpara> - </listitem> - <listitem> - <simpara> - KEYWORD "string" - match messages with "string" as a keyword - </simpara> - </listitem> - <listitem> - <simpara> - NEW - match new messages - </simpara> - </listitem> - <listitem> - <simpara> - OLD - match old messages - </simpara> - </listitem> - <listitem> - <simpara> - ON "date" - match messages with Date: matching "date" - </simpara> - </listitem> - <listitem> - <simpara> - RECENT - match messages with the \\RECENT flag set - </simpara> - </listitem> - <listitem> - <simpara> - SEEN - match messages that have been read (the \\SEEN flag is set) - </simpara> - </listitem> - <listitem> - <simpara> - SINCE "date" - match messages with Date: after "date" - </simpara> - </listitem> - <listitem> - <simpara> - SUBJECT "string" - match messages with "string" in the Subject: - </simpara> - </listitem> - <listitem> - <simpara> - TEXT "string" - match messages with text "string" - </simpara> - </listitem> - <listitem> - <simpara> - TO "string" - match messages with "string" in the To: - </simpara> - </listitem> - <listitem> - <simpara> - UNANSWERED - match messages that have not been answered - </simpara> - </listitem> - <listitem> - <simpara> - UNDELETED - match messages that are not deleted - </simpara> - </listitem> - <listitem> - <simpara> - UNFLAGGED - match messages that are not flagged - </simpara> - </listitem> - <listitem> - <simpara> - UNKEYWORD "string" - match messages that do not have the - keyword "string" - </simpara> - </listitem> - <listitem> - <simpara> - UNSEEN - match messages which have not been read yet - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - For example, to match all unanswered messages sent by Mom, you'd - use: "UNANSWERED FROM mom". Searches appear to be case - insensitive. This list of criteria is from a reading of the UW - c-client source code and may be incomplete or - inaccurate (see also <ulink url="&url.rfc;2060">RFC2060</ulink>, section 6.4.4). - </para> - <para> - Valid values for flags are SE_UID, which causes the returned - array to contain UIDs instead of messages sequence numbers. - </para> - <para> - Parameter <parameter>charset</parameter> was added in PHP 4.3.3. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.8 $ --> +<refentry id="function.imap-search"> + <refnamediv> + <refname>imap_search</refname> + <refpurpose>This function returns an array of messages matching the given search criteria</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_search</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>criteria</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + </methodsynopsis> + <para> + This function performs a search on the mailbox currently opened + in the given imap stream. <parameter>criteria</parameter> is a + string, delimited by spaces, in which the following keywords are + allowed. Any multi-word arguments (e.g. FROM "joey smith") must be + quoted. + <itemizedlist> + <listitem> + <simpara> + ALL - return all messages matching the rest of the criteria + </simpara> + </listitem> + <listitem> + <simpara> + ANSWERED - match messages with the \\ANSWERED flag set + </simpara> + </listitem> + <listitem> + <simpara> + BCC "string" - match messages with "string" in the Bcc: field + </simpara> + </listitem> + <listitem> + <simpara> + BEFORE "date" - match messages with Date: before "date" + </simpara> + </listitem> + <listitem> + <simpara> + BODY "string" - match messages with "string" in the body of the message + </simpara> + </listitem> + <listitem> + <simpara> + CC "string" - match messages with "string" in the Cc: field + </simpara> + </listitem> + <listitem> + <simpara> + DELETED - match deleted messages + </simpara> + </listitem> + <listitem> + <simpara> + FLAGGED - match messages with the \\FLAGGED (sometimes + referred to as Important or Urgent) flag set + </simpara> + </listitem> + <listitem> + <simpara> + FROM "string" - match messages with "string" in the From: field + </simpara> + </listitem> + <listitem> + <simpara> + KEYWORD "string" - match messages with "string" as a keyword + </simpara> + </listitem> + <listitem> + <simpara> + NEW - match new messages + </simpara> + </listitem> + <listitem> + <simpara> + OLD - match old messages + </simpara> + </listitem> + <listitem> + <simpara> + ON "date" - match messages with Date: matching "date" + </simpara> + </listitem> + <listitem> + <simpara> + RECENT - match messages with the \\RECENT flag set + </simpara> + </listitem> + <listitem> + <simpara> + SEEN - match messages that have been read (the \\SEEN flag is set) + </simpara> + </listitem> + <listitem> + <simpara> + SINCE "date" - match messages with Date: after "date" + </simpara> + </listitem> + <listitem> + <simpara> + SUBJECT "string" - match messages with "string" in the Subject: + </simpara> + </listitem> + <listitem> + <simpara> + TEXT "string" - match messages with text "string" + </simpara> + </listitem> + <listitem> + <simpara> + TO "string" - match messages with "string" in the To: + </simpara> + </listitem> + <listitem> + <simpara> + UNANSWERED - match messages that have not been answered + </simpara> + </listitem> + <listitem> + <simpara> + UNDELETED - match messages that are not deleted + </simpara> + </listitem> + <listitem> + <simpara> + UNFLAGGED - match messages that are not flagged + </simpara> + </listitem> + <listitem> + <simpara> + UNKEYWORD "string" - match messages that do not have the + keyword "string" + </simpara> + </listitem> + <listitem> + <simpara> + UNSEEN - match messages which have not been read yet + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + For example, to match all unanswered messages sent by Mom, you'd + use: "UNANSWERED FROM mom". Searches appear to be case + insensitive. This list of criteria is from a reading of the UW + c-client source code and may be incomplete or + inaccurate (see also <ulink url="&url.rfc;2060">RFC2060</ulink>, section 6.4.4). + </para> + <para> + Valid values for flags are SE_UID, which causes the returned + array to contain UIDs instead of messages sequence numbers. + </para> + <para> + Parameter <parameter>charset</parameter> was added in PHP 4.3.3. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-set-quota.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-set-quota.xml diff -u phpdoc/en/reference/imap/functions/imap-set-quota.xml:1.8 phpdoc/en/reference/imap/functions/imap-set-quota.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-set-quota.xml:1.8 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-set-quota.xml Sun Jan 14 15:37:21 2007 @@ -1,45 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-set-quota"> - <refnamediv> - <refname>imap_set_quota</refname> - <refpurpose>Sets a quota for a given mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_set_quota</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> - <methodparam><type>int</type><parameter>quota_limit</parameter></methodparam> - </methodsynopsis> - <para> - Sets an upper limit quota on a per mailbox basis. This function - requires the <parameter>imap_stream</parameter> to have been opened - as the mail administrator account. It will not work if opened as - any other user. - </para> - <para> - This function is currently only available to users of the c-client2000 - or greater library. - </para> - <para> - <parameter>imap_stream</parameter> is the stream pointer returned from - a <function>imap_open</function> call. This stream must be opened as - the mail administrator, other wise this function will fail. - <parameter>quota_root</parameter> is the mailbox to have a quota set. This - should follow the IMAP standard format for a mailbox, 'user.name'. - <parameter>quota_limit</parameter> is the maximum size (in KB) for - the <parameter>quota_root</parameter>. - </para> - <para> - Returns &true; on success and &false; on error. - </para> - <para> - <example> - <title><function>imap_set_quota</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.9 $ --> +<refentry id="function.imap-set-quota"> + <refnamediv> + <refname>imap_set_quota</refname> + <refpurpose>Sets a quota for a given mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_set_quota</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> + <methodparam><type>int</type><parameter>quota_limit</parameter></methodparam> + </methodsynopsis> + <para> + Sets an upper limit quota on a per mailbox basis. This function + requires the <parameter>imap_stream</parameter> to have been opened + as the mail administrator account. It will not work if opened as + any other user. + </para> + <para> + This function is currently only available to users of the c-client2000 + or greater library. + </para> + <para> + <parameter>imap_stream</parameter> is the stream pointer returned from + a <function>imap_open</function> call. This stream must be opened as + the mail administrator, other wise this function will fail. + <parameter>quota_root</parameter> is the mailbox to have a quota set. This + should follow the IMAP standard format for a mailbox, 'user.name'. + <parameter>quota_limit</parameter> is the maximum size (in KB) for + the <parameter>quota_root</parameter>. + </para> + <para> + Returns &true; on success and &false; on error. + </para> + <para> + <example> + <title><function>imap_set_quota</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org:143}", "mailadmin", "password"); @@ -52,15 +51,15 @@ imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>imap_open</function> and - <function>imap_get_quota</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>imap_open</function> and + <function>imap_get_quota</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-setacl.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-setacl.xml diff -u phpdoc/en/reference/imap/functions/imap-setacl.xml:1.5 phpdoc/en/reference/imap/functions/imap-setacl.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-setacl.xml:1.5 Tue Aug 31 01:20:59 2004 +++ phpdoc/en/reference/imap/functions/imap-setacl.xml Sun Jan 14 15:37:21 2007 @@ -1,34 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 --> - <refentry id='function.imap-setacl'> - <refnamediv> - <refname>imap_setacl</refname> - <refpurpose> - Sets the ACL for a giving mailbox - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_setacl</methodname> - <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> - <methodparam><type>string</type><parameter>id</parameter></methodparam> - <methodparam><type>string</type><parameter>rights</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - <para> - This function is currently only available to users of the c-client2000 - or greater library. - </para> - <para> - See also <function>imap_getacl</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id='function.imap-setacl'> + <refnamediv> + <refname>imap_setacl</refname> + <refpurpose>Sets the ACL for a giving mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_setacl</methodname> + <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>string</type><parameter>id</parameter></methodparam> + <methodparam><type>string</type><parameter>rights</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + <para> + This function is currently only available to users of the c-client2000 + or greater library. + </para> + <para> + See also <function>imap_getacl</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-setflag-full.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-setflag-full.xml diff -u phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.11 phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.12 --- phpdoc/en/reference/imap/functions/imap-setflag-full.xml:1.11 Tue Sep 12 21:43:35 2006 +++ phpdoc/en/reference/imap/functions/imap-setflag-full.xml Sun Jan 14 15:37:21 2007 @@ -1,67 +1,66 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-setflag-full"> - <refnamediv> - <refname>imap_setflag_full</refname> - <refpurpose>Sets flags on messages</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_setflag_full</methodname> - <methodparam><type>resource</type><parameter>stream</parameter></methodparam> - <methodparam><type>string</type><parameter>sequence</parameter></methodparam> - <methodparam><type>string</type><parameter>flag</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - This function causes a store to add the specified - <parameter>flag</parameter> to the flags set for the messages - in the specified <parameter>sequence</parameter>. - </para> - <para> - The flags which you can set are "\\Seen", "\\Answered", - "\\Flagged", "\\Deleted", and "\\Draft" (as defined - by <ulink url="&url.rfc;2060">RFC2060</ulink>). - </para> - <para> - <parameter>options</parameter> are a bit mask and may contain - the single option: - <itemizedlist> - <listitem> - <simpara> - <constant>ST_UID</constant> - The sequence argument contains UIDs - instead of sequence numbers - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - <example> - <title><function>imap_setflag_full</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.12 $ --> +<refentry id="function.imap-setflag-full"> + <refnamediv> + <refname>imap_setflag_full</refname> + <refpurpose>Sets flags on messages</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_setflag_full</methodname> + <methodparam><type>resource</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>sequence</parameter></methodparam> + <methodparam><type>string</type><parameter>flag</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + This function causes a store to add the specified + <parameter>flag</parameter> to the flags set for the messages + in the specified <parameter>sequence</parameter>. + </para> + <para> + The flags which you can set are "\\Seen", "\\Answered", + "\\Flagged", "\\Deleted", and "\\Draft" (as defined + by <ulink url="&url.rfc;2060">RFC2060</ulink>). + </para> + <para> + <parameter>options</parameter> are a bit mask and may contain + the single option: + <itemizedlist> + <listitem> + <simpara> + <constant>ST_UID</constant> - The sequence argument contains UIDs + instead of sequence numbers + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + <example> + <title><function>imap_setflag_full</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org:143}", "username", "password") or die("can't connect: " . imap_last_error()); - + $status = imap_setflag_full($mbox, "2,5", "\\Seen \\Flagged"); - + echo gettype($status) . "\n"; echo $status . "\n"; - + imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also: <function>imap_clearflag_full</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also: <function>imap_clearflag_full</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-sort.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-sort.xml diff -u phpdoc/en/reference/imap/functions/imap-sort.xml:1.5 phpdoc/en/reference/imap/functions/imap-sort.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-sort.xml:1.5 Mon Aug 16 08:26:59 2004 +++ phpdoc/en/reference/imap/functions/imap-sort.xml Sun Jan 14 15:37:21 2007 @@ -1,89 +1,88 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-sort"> - <refnamediv> - <refname>imap_sort</refname> - <refpurpose>Sort an array of message headers</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_sort</methodname> - <methodparam><type>resource</type><parameter>stream</parameter></methodparam> - <methodparam><type>int</type><parameter>criteria</parameter></methodparam> - <methodparam><type>int</type><parameter>reverse</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>search_criteria</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> - </methodsynopsis> - <para> - Returns an array of message numbers sorted by the given - parameters. - </para> - <para> - <parameter>Reverse</parameter> is 1 for reverse-sorting. - </para> - <para> - Criteria can be one (and only one) of the following: - <itemizedlist> - <listitem> - <simpara> - <constant>SORTDATE</constant> - message Date - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTARRIVAL</constant> - arrival date - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTFROM</constant> - mailbox in first From address - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTSUBJECT</constant> - message subject - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTTO</constant> - mailbox in first To address - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTCC</constant> - mailbox in first cc address - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SORTSIZE</constant> - size of message in octets - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - The flags are a bitmask of one or more of the following: - <itemizedlist> - <listitem> - <simpara> - <constant>SE_UID</constant> - Return UIDs instead of sequence numbers - </simpara> - </listitem> - <listitem> - <simpara> - <constant>SE_NOPREFETCH</constant> - Don't prefetch searched messages - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - Parameter <parameter>charset</parameter> was added in PHP 4.3.3. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.imap-sort"> + <refnamediv> + <refname>imap_sort</refname> + <refpurpose>Sort an array of message headers</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_sort</methodname> + <methodparam><type>resource</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>criteria</parameter></methodparam> + <methodparam><type>int</type><parameter>reverse</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>search_criteria</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + </methodsynopsis> + <para> + Returns an array of message numbers sorted by the given + parameters. + </para> + <para> + <parameter>Reverse</parameter> is 1 for reverse-sorting. + </para> + <para> + Criteria can be one (and only one) of the following: + <itemizedlist> + <listitem> + <simpara> + <constant>SORTDATE</constant> - message Date + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTARRIVAL</constant> - arrival date + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTFROM</constant> - mailbox in first From address + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTSUBJECT</constant> - message subject + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTTO</constant> - mailbox in first To address + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTCC</constant> - mailbox in first cc address + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SORTSIZE</constant> - size of message in octets + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + The flags are a bitmask of one or more of the following: + <itemizedlist> + <listitem> + <simpara> + <constant>SE_UID</constant> - Return UIDs instead of sequence numbers + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SE_NOPREFETCH</constant> - Don't prefetch searched messages + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + Parameter <parameter>charset</parameter> was added in PHP 4.3.3. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-status.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-status.xml diff -u phpdoc/en/reference/imap/functions/imap-status.xml:1.9 phpdoc/en/reference/imap/functions/imap-status.xml:1.10 --- phpdoc/en/reference/imap/functions/imap-status.xml:1.9 Mon Jan 23 01:48:07 2006 +++ phpdoc/en/reference/imap/functions/imap-status.xml Sun Jan 14 15:37:21 2007 @@ -1,83 +1,79 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 --> - <refentry id="function.imap-status"> - <refnamediv> - <refname>imap_status</refname> - <refpurpose> - This function returns status information on a mailbox other than - the current one - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>imap_status</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> - <methodparam><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - This function returns an object containing status - information. Valid flags are: - <itemizedlist> - <listitem> - <simpara> - SA_MESSAGES - set status->messages to the number of messages - in the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - SA_RECENT - set status->recent to the number of recent - messages in the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - SA_UNSEEN - set status->unseen to the number of unseen (new) - messages in the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - SA_UIDNEXT - set status->uidnext to the next uid to be used in - the mailbox - </simpara> - </listitem> - <listitem> - <simpara> - SA_UIDVALIDITY - set status->uidvalidity to a constant that - changes when uids for the mailbox may no longer be valid - </simpara> - </listitem> - <listitem> - <simpara> - SA_ALL - set all of the above - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - status->flags is also set, which contains a bitmask which can be - checked against any of the above constants. - </para> - <para> - <example> - <title><function>imap_status</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.10 $ --> +<refentry id="function.imap-status"> + <refnamediv> + <refname>imap_status</refname> + <refpurpose>This function returns status information on a mailbox other than the current one</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>imap_status</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + This function returns an object containing status + information. Valid flags are: + <itemizedlist> + <listitem> + <simpara> + SA_MESSAGES - set status->messages to the number of messages + in the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + SA_RECENT - set status->recent to the number of recent + messages in the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + SA_UNSEEN - set status->unseen to the number of unseen (new) + messages in the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + SA_UIDNEXT - set status->uidnext to the next uid to be used in + the mailbox + </simpara> + </listitem> + <listitem> + <simpara> + SA_UIDVALIDITY - set status->uidvalidity to a constant that + changes when uids for the mailbox may no longer be valid + </simpara> + </listitem> + <listitem> + <simpara> + SA_ALL - set all of the above + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + status->flags is also set, which contains a bitmask which can be + checked against any of the above constants. + </para> + <para> + <example> + <title><function>imap_status</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN) or die("can't connect: " . imap_last_error()); - + $status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL); if ($status) { 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"; + echo "UIDvalidity:" . $status->uidvalidity . "<br />\n"; } else { echo "imap_status failed: " . imap_last_error() . "\n"; } @@ -85,11 +81,11 @@ imap_close($mbox); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-subscribe.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-subscribe.xml diff -u phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.5 phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-subscribe.xml:1.5 Mon Mar 8 09:18:44 2004 +++ phpdoc/en/reference/imap/functions/imap-subscribe.xml Sun Jan 14 15:37:21 2007 @@ -1,29 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.7 --> - <refentry id="function.imap-subscribe"> - <refnamediv> - <refname>imap_subscribe</refname> - <refpurpose>Subscribe to a mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_subscribe</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> - </methodsynopsis> - <para> - Subscribe to a new mailbox. - </para> - <para> - &return.success; - </para> - <para> - See also: <function>imap_unsubscribe</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.imap-subscribe"> + <refnamediv> + <refname>imap_subscribe</refname> + <refpurpose>Subscribe to a mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_subscribe</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + </methodsynopsis> + <para> + Subscribe to a new mailbox. + </para> + <para> + &return.success; + </para> + <para> + See also: <function>imap_unsubscribe</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-thread.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-thread.xml diff -u phpdoc/en/reference/imap/functions/imap-thread.xml:1.6 phpdoc/en/reference/imap/functions/imap-thread.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-thread.xml:1.6 Sat Oct 29 09:08:45 2005 +++ phpdoc/en/reference/imap/functions/imap-thread.xml Sun Jan 14 15:37:21 2007 @@ -1,44 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 --> - <refentry id='function.imap-thread'> - <refnamediv> - <refname>imap_thread</refname> - <refpurpose> - Returns a tree of threaded message - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>imap_thread</methodname> - <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - <function>imap_thread</function> returns an associative array containing - a tree of messages threaded by <literal>REFERENCES</literal>, or &false; - on error. - </para> - <para> - Every message in the current mailbox will be represented by three entries - in the resulting array: - <itemizedlist> - <listitem><para> - <varname>$thread["XX.num"]</varname> - current message number - </para></listitem> - <listitem><para> - <varname>$thread["XX.next"]</varname> - </para></listitem> - <listitem><para> - <varname>$thread["XX.branch"]</varname> - </para></listitem> - </itemizedlist> - </para> - <para> - <example> - <title><function>imap_thread</function> Example</title> - <programlisting role="php"> +<!-- $Revision: 1.7 $ --> +<refentry id='function.imap-thread'> + <refnamediv> + <refname>imap_thread</refname> + <refpurpose>Returns a tree of threaded message</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>imap_thread</methodname> + <methodparam><type>resource</type><parameter>stream_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + <function>imap_thread</function> returns an associative array containing + a tree of messages threaded by <literal>REFERENCES</literal>, or &false; + on error. + </para> + <para> + Every message in the current mailbox will be represented by three entries + in the resulting array: + <itemizedlist> + <listitem><para> + <varname>$thread["XX.num"]</varname> - current message number + </para></listitem> + <listitem><para> + <varname>$thread["XX.next"]</varname> + </para></listitem> + <listitem><para> + <varname>$thread["XX.branch"]</varname> + </para></listitem> + </itemizedlist> + </para> + <para> + <example> + <title><function>imap_thread</function> Example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -61,11 +58,11 @@ ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-timeout.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-timeout.xml diff -u phpdoc/en/reference/imap/functions/imap-timeout.xml:1.1 phpdoc/en/reference/imap/functions/imap-timeout.xml:1.2 --- phpdoc/en/reference/imap/functions/imap-timeout.xml:1.1 Sun Nov 2 18:00:47 2003 +++ phpdoc/en/reference/imap/functions/imap-timeout.xml Sun Jan 14 15:37:21 2007 @@ -1,24 +1,22 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> - <refentry id="function.imap-timeout"> - <refnamediv> - <refname>imap_timeout</refname> - <refpurpose> - Set or fetch imap timeout - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>imap_timeout</methodname> - <methodparam><type>int</type><parameter>timeout_type</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - </methodsynopsis> +<!-- $Revision: 1.2 $ --> +<refentry id="function.imap-timeout"> + <refnamediv> + <refname>imap_timeout</refname> + <refpurpose>Set or fetch imap timeout</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>mixed</type><methodname>imap_timeout</methodname> + <methodparam><type>int</type><parameter>timeout_type</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-uid.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-uid.xml diff -u phpdoc/en/reference/imap/functions/imap-uid.xml:1.5 phpdoc/en/reference/imap/functions/imap-uid.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-uid.xml:1.5 Mon Oct 17 12:36:02 2005 +++ phpdoc/en/reference/imap/functions/imap-uid.xml Sun Jan 14 15:37:21 2007 @@ -1,38 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> - <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> - <methodsynopsis> - <type>int</type><methodname>imap_uid</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>msgno</parameter></methodparam> - </methodsynopsis> - <para> - This function returns the UID for the given message sequence - number. An UID is a unique identifier that will not change over - time while a message sequence number may change whenever the - content of the mailbox changes. This function is the inverse of - <function>imap_msgno</function>. - </para> - <note> - <para> - This is not supported by POP3 mailboxes. - </para> - </note> - <para> - See also: <function>imap_msgno</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<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> + <methodsynopsis> + <type>int</type><methodname>imap_uid</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msgno</parameter></methodparam> + </methodsynopsis> + <para> + This function returns the UID for the given message sequence + number. An UID is a unique identifier that will not change over + time while a message sequence number may change whenever the + content of the mailbox changes. This function is the inverse of + <function>imap_msgno</function>. + </para> + <note> + <para> + This is not supported by POP3 mailboxes. + </para> + </note> + <para> + See also: <function>imap_msgno</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-undelete.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-undelete.xml diff -u phpdoc/en/reference/imap/functions/imap-undelete.xml:1.6 phpdoc/en/reference/imap/functions/imap-undelete.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-undelete.xml:1.6 Wed Aug 18 14:15:17 2004 +++ phpdoc/en/reference/imap/functions/imap-undelete.xml Sun Jan 14 15:37:21 2007 @@ -1,36 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> - <refentry id="function.imap-undelete"> - <refnamediv> - <refname>imap_undelete</refname> - <refpurpose> - Unmark the message which is marked deleted - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_undelete</methodname> - <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> - </methodsynopsis> - <para> - This function removes the deletion flag for a specified message, - which is set by <function>imap_delete</function> or - <function>imap_mail_move</function>. - </para> - <para> - &return.success; - </para> - <para> - See also: - <function>imap_delete</function>, and - <function>imap_mail_move</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<refentry id="function.imap-undelete"> + <refnamediv> + <refname>imap_undelete</refname> + <refpurpose>Unmark the message which is marked deleted</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_undelete</methodname> + <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> + <para> + This function removes the deletion flag for a specified message, + which is set by <function>imap_delete</function> or + <function>imap_mail_move</function>. + </para> + <para> + &return.success; + </para> + <para> + See also: + <function>imap_delete</function>, and + <function>imap_mail_move</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-unsubscribe.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-unsubscribe.xml diff -u phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.5 phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.6 --- phpdoc/en/reference/imap/functions/imap-unsubscribe.xml:1.5 Mon Mar 8 09:18:44 2004 +++ phpdoc/en/reference/imap/functions/imap-unsubscribe.xml Sun Jan 14 15:37:21 2007 @@ -1,29 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> - <refentry id="function.imap-unsubscribe"> - <refnamediv> - <refname>imap_unsubscribe</refname> - <refpurpose>Unsubscribe from a mailbox</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>imap_unsubscribe</methodname> - <methodparam><type>string</type><parameter>imap_stream</parameter></methodparam> - <methodparam><type>string</type><parameter>mbox</parameter></methodparam> - </methodsynopsis> - <para> - Unsubscribe from a specified mailbox. - </para> - <para> - &return.success; - </para> - <para> - See also: <function>imap_subscribe</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.imap-unsubscribe"> + <refnamediv> + <refname>imap_unsubscribe</refname> + <refpurpose>Unsubscribe from a mailbox</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>imap_unsubscribe</methodname> + <methodparam><type>string</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + </methodsynopsis> + <para> + Unsubscribe from a specified mailbox. + </para> + <para> + &return.success; + </para> + <para> + See also: <function>imap_subscribe</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-utf7-decode.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-utf7-decode.xml diff -u phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.7 phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.8 --- phpdoc/en/reference/imap/functions/imap-utf7-decode.xml:1.7 Fri Aug 20 09:36:59 2004 +++ phpdoc/en/reference/imap/functions/imap-utf7-decode.xml Sun Jan 14 15:37:21 2007 @@ -1,44 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.16 --> - <refentry id="function.imap-utf7-decode"> - <refnamediv> - <refname>imap_utf7_decode</refname> - <refpurpose> - Decodes a modified UTF-7 encoded string - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>imap_utf7_decode</methodname> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - </methodsynopsis> - <para> - Decodes modified UTF-7 <parameter>text</parameter> into ISO-8859-1 string. - </para> - <para> - Returns a string that is encoded in ISO-8859-1 and consists of the same - sequence of characters in <parameter>text</parameter>, or &false; - if <parameter>text</parameter> contains invalid modified UTF-7 sequence - or <parameter>text</parameter> contains a character that is not part of - ISO-8859-1 character set. - </para> - <para> - This function is needed to decode mailbox names that contain certain - characters which are not in range of printable ASCII characters. - </para> - <para> - The modified UTF-7 encoding is defined in - <ulink url="&url.rfc;2060">RFC 2060</ulink>, section - 5.1.3 (original UTF-7 was defined in <ulink - url="&url.rfc;1642">RFC1642</ulink>). - </para> - <para> - See also: <function>imap_utf7_encode</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.8 $ --> +<refentry id="function.imap-utf7-decode"> + <refnamediv> + <refname>imap_utf7_decode</refname> + <refpurpose>Decodes a modified UTF-7 encoded string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>imap_utf7_decode</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> + <para> + Decodes modified UTF-7 <parameter>text</parameter> into ISO-8859-1 string. + </para> + <para> + Returns a string that is encoded in ISO-8859-1 and consists of the same + sequence of characters in <parameter>text</parameter>, or &false; + if <parameter>text</parameter> contains invalid modified UTF-7 sequence + or <parameter>text</parameter> contains a character that is not part of + ISO-8859-1 character set. + </para> + <para> + This function is needed to decode mailbox names that contain certain + characters which are not in range of printable ASCII characters. + </para> + <para> + The modified UTF-7 encoding is defined in + <ulink url="&url.rfc;2060">RFC 2060</ulink>, section + 5.1.3 (original UTF-7 was defined in <ulink + url="&url.rfc;1642">RFC1642</ulink>). + </para> + <para> + See also: <function>imap_utf7_encode</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-utf7-encode.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-utf7-encode.xml diff -u phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.8 phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-utf7-encode.xml:1.8 Fri Aug 20 09:36:59 2004 +++ phpdoc/en/reference/imap/functions/imap-utf7-encode.xml Sun Jan 14 15:37:21 2007 @@ -1,39 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.9 --> - <refentry id="function.imap-utf7-encode"> - <refnamediv> - <refname>imap_utf7_encode</refname> - <refpurpose> - Converts ISO-8859-1 string to modified UTF-7 text - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>imap_utf7_encode</methodname> - <methodparam><type>string</type><parameter>data</parameter></methodparam> - </methodsynopsis> - <para> - Converts <parameter>data</parameter> to modified UTF-7 - text. Note that <parameter>data</parameter> is expected to be - encoded in ISO-8859-1. - </para> - <para> - This is needed to encode mailbox names that contain certain - characters which are not in range of printable ASCII characters. - </para> - <para> - The modified UTF-7 encoding is defined in <ulink - url="&url.rfc;2060">RFC 2060</ulink>, section 5.1.3 - (original UTF-7 was defined in <ulink - url="&url.rfc;1642">RFC1642</ulink>). - </para> - <para> - See also: <function>imap_utf7_decode</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.9 $ --> +<refentry id="function.imap-utf7-encode"> + <refnamediv> + <refname>imap_utf7_encode</refname> + <refpurpose>Converts ISO-8859-1 string to modified UTF-7 text</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>imap_utf7_encode</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> + <para> + Converts <parameter>data</parameter> to modified UTF-7 + text. Note that <parameter>data</parameter> is expected to be + encoded in ISO-8859-1. + </para> + <para> + This is needed to encode mailbox names that contain certain + characters which are not in range of printable ASCII characters. + </para> + <para> + The modified UTF-7 encoding is defined in <ulink + url="&url.rfc;2060">RFC 2060</ulink>, section 5.1.3 + (original UTF-7 was defined in <ulink + url="&url.rfc;1642">RFC1642</ulink>). + </para> + <para> + See also: <function>imap_utf7_decode</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-utf8.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-utf8.xml diff -u phpdoc/en/reference/imap/functions/imap-utf8.xml:1.6 phpdoc/en/reference/imap/functions/imap-utf8.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-utf8.xml:1.6 Wed Dec 14 13:00:25 2005 +++ phpdoc/en/reference/imap/functions/imap-utf8.xml Sun Jan 14 15:37:21 2007 @@ -1,30 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/imap.xml, last change in rev 1.7 --> - <refentry id="function.imap-utf8"> - <refnamediv> - <refname>imap_utf8</refname> - <refpurpose> - Converts MIME-encoded text to UTF-8 - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>imap_utf8</methodname> - <methodparam><type>string</type><parameter>mime_encoded_text</parameter></methodparam> - </methodsynopsis> - <para> - Converts the given <parameter>mime_encoded_text</parameter> to - UTF-8. MIME encoding method and the UTF-8 specification are described in - <ulink url="&url.rfc;2047">RFC2047</ulink> and - <ulink url="&url.rfc;2044">RFC2044</ulink> respectively. - </para> - <para> - See also <function>imap_mime_header_decode</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<refentry id="function.imap-utf8"> + <refnamediv> + <refname>imap_utf8</refname> + <refpurpose>Converts MIME-encoded text to UTF-8</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>imap_utf8</methodname> + <methodparam><type>string</type><parameter>mime_encoded_text</parameter></methodparam> + </methodsynopsis> + <para> + Converts the given <parameter>mime_encoded_text</parameter> to + UTF-8. MIME encoding method and the UTF-8 specification are described in + <ulink url="&url.rfc;2047">RFC2047</ulink> and + <ulink url="&url.rfc;2044">RFC2044</ulink> respectively. + </para> + <para> + See also <function>imap_mime_header_decode</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: