sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

... should now contain all the additions and corrections i've

Browse source 
put into the german version during translation


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@20980 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2000-03-05 16:07:55 +00:00
parent 011c5396d5
commit c2db5ba523
1 changed files with 423 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

506
functions/imap.xml
View file

@ -1,5 +1,5 @@
<reference id="ref.imap">
<title>IMAP functions</title>
<title>IMAP, POP3 and NNTP functions</title>
<titleabbrev>IMAP</titleabbrev>
<partintro>
@ -9,8 +9,9 @@
c-client library to be installed. Grab the latest version from
<ulink url="&url.imap;">&url.imap;</ulink> and compile it. Then
copy <filename>c-client/c-client.a</filename> to
<filename>/usr/local/lib</filename> or some other directory on
your link path and copy <filename>c-client/rfc822.h</filename>,
<filename>/usr/local/lib/libc-client.a</filename> or some other
directory on your link path and copy
<filename>c-client/rfc822.h</filename>,
<filename>mail.h</filename> and <filename>linkage.h</filename> to
<filename>/usr/local/include</filename> or some other directory in
your include path.
@ -19,9 +20,66 @@
Note that these functions are not limited to the
<acronym>IMAP</acronym> protocol, despite their name. The
underlying c-client library also supports <acronym>NNTP</acronym>,
<acronym>POP3</acronym> and local mailbox access methods. See the
<function>imap_open</function> for more information.
<acronym>POP3</acronym> and local mailbox access methods.
</simpara>
<para>
This document can't go into detail on all the topics touched by the
provided functions. Further information is provided by the
documentation of the c-client library source
(<filename>docs/internal.txt</filename>)
and the following RFC documents:
<itemizedlist>
<listitem>
<simpara>
<ulink url="&url.rfc;/rfc821.html">RFC821</ulink> :
Simple Mail Transfer Protocol (SMTP)
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;/rfc822.html">RFC822</ulink> :
Standard for ARPA internet text messages
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;/rfc2060.html">RFC2060</ulink> :
Internet Message Access Protocol (IMAP) Version 4rev1
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;/rfc1939.html">RFC1939</ulink> :
Post Office Protocol Version 3 (POP3)
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;/rfc977.html">RFC977</ulink> :
Network News Transfer Protocol (NNTP)
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;/rfc2076.html">RFC2076</ulink> :
Common Internet Message Headers
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;/rfc2045.html">RFC2045</ulink> ,
<ulink url="&url.rfc;/rfc2046.html">RFC2046</ulink> ,
<ulink url="&url.rfc;/rfc2047.html">RFC2047</ulink> ,
<ulink url="&url.rfc;/rfc2048.html">RFC2048</ulink> &amp;
<ulink url="&url.rfc;/rfc2049.html">RFC2049</ulink> :
Multipurpose Internet Mail Extensions (MIME)
</simpara>
</listitem>
</itemizedlist>
A detailed overview is also available in the book
<ulink url="&url.email.book;">Programming Internet Email</ulink>
by David Wood.
</para>
</partintro>
<refentry id="function.imap-append">
@ -38,7 +96,7 @@
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>string <parameter>mbox</parameter></paramdef>
<paramdef>string <parameter>message</parameter></paramdef>
<paramdef>string<parameter>flags</parameter></paramdef>
<paramdef>string<parameter><optional>flags</optional></parameter></paramdef>
</funcsynopsis>
<para>
Returns true on sucess, false on error.
@ -69,7 +127,11 @@
</funcsynopsis>
<para>
<function>imap_base64</function> function decodes BASE-64 encoded
text. The decoded message is returned as a string.
text (see <ulink url="&url.rfc;/rfc2045.html">RFC2045</ulink>,
Section 6.8). The decoded message is returned as a string.
</para>
<para>
See also <function>imap_binary</function>.
</para>
</refsect1>
</refentry>
@ -86,7 +148,7 @@
<funcdef>string <function>imap_body</function></funcdef>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>int <parameter>msg_number</parameter></paramdef>
<paramdef>int <parameter>flags</parameter></paramdef>
<paramdef>int <parameter><optional>flags</optional></parameter></paramdef>
</funcsynopsis>
<para>
<function>imap_body</function> returns the body of the message,
@ -96,7 +158,7 @@
<itemizedlist>
<listitem>
<simpara>
FT_UID - The msgno is a UID
FT_UID - The <parameter>msgno</parameter> is a UID
</simpara>
</listitem>
<listitem>
@ -133,18 +195,36 @@
<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.
object with following properties:
</para>
<para>
<informalexample>
<literallayout>
Date : date of the message
Driver : driver
Mailbox : name of the mailbox
Nmsgs : number of messages
Recent : number of recent messages
</literallayout>
</informalexample>
<itemizedlist>
<listitem>
<simpara>
Date - last change of mailbox contents
</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>
</refsect1>
</refentry>
@ -159,7 +239,7 @@
<funcsynopsis>
<funcdef>int <function>imap_close</function></funcdef>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>int <parameter>flags</parameter></paramdef>
<paramdef>int <parameter><optional>flags</optional></parameter></paramdef>
</funcsynopsis>
<para>
Close the imap stream. Takes an optional
@ -184,15 +264,15 @@
<para>
<function>imap_createmailbox</function> creates a new mailbox
specified by <parameter>mbox</parameter>
(see <function>imap_open</function> for the format
of <parameter>mbox</parameter> names).
</para>
<para>
Returns true on success and false on error.
</para>
<para>
See also <function>imap_renamemailbox</function> and
<function>imap_deletemailbox</function>.
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>
@ -210,15 +290,21 @@
<funcdef>int <function>imap_delete</function></funcdef>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>int <parameter>msg_number</parameter></paramdef>
<paramdef>int <parameter><optional>flags</optional></parameter></paramdef>
</funcsynopsis>
<para>
Returns true.
</para>
<para>
<function>imap_delete</function> function marks message pointed
by <parameter>msg_number</parameter> for deletion. Actual
deletion of the messages is done by
<function>imap_expunge</function>.
by <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>
</refsect1>
</refentry>
@ -244,8 +330,10 @@
Returns true on success and false on error.
</para>
<para>
See also <function>imap_createmailbox</function> and
<function>imap_reanmemailbox</function>.
See also <function>imap_createmailbox</function>,
<function>imap_reanmemailbox</function> and
<function>imap_open</function> for the format of
<parameter>mbox</parameter>.
</para>
</refsect1>
</refentry>
@ -263,7 +351,10 @@
</funcsynopsis>
<para>
<function>imap_expunge</function> deletes all the messages marked
for deletion by <function>imap_delete</function>.</para>
for deletion by <function>imap_delete</function>,
<function>imap_move_mail</function> or
<function>imap_setflag_full</function>.
</para>
<para>
Returns true.
</para>
@ -283,7 +374,7 @@
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>int <parameter>msg_number</parameter></paramdef>
<paramdef>string <parameter>part_number</parameter></paramdef>
<paramdef>flags <parameter>flags</parameter></paramdef>
<paramdef>flags <parameter><optional>flags</optional></parameter></paramdef>
</funcsynopsis>
<para>
This function causes a fetch of a particular section of the body
@ -298,7 +389,7 @@
<itemizedlist>
<listitem>
<simpara>
FT_UID - The msgono is a UID
FT_UID - The <parameter>msg_number</parameter> is a UID
</simpara>
</listitem>
<listitem>
@ -629,10 +720,12 @@ fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter>
<funcdef>array <function>imap_listmailbox</function></funcdef>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>string <parameter>ref</parameter></paramdef>
<paramdef>string <parameter>pat</parameter></paramdef>
<paramdef>string <parameter>pattern</parameter></paramdef>
</funcsynopsis>
<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>
</refsect1>
</refentry>
@ -651,7 +744,7 @@ fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter>
<funcdef>array <function>imap_getmailboxes</function></funcdef>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>string <parameter>ref</parameter></paramdef>
<paramdef>string <parameter>pat</parameter></paramdef>
<paramdef>string <parameter>pattern</parameter></paramdef>
</funcsynopsis>
<para>
Returns an array of objects containing mailbox information. Each
@ -723,10 +816,9 @@ fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter>
</funcsynopsis>
<para>
Returns an array of all the mailboxes that you have
subscribed. The <parameter>ref</parameter> and
<parameter>pattern</parameter> arguments specify the base
location to search from and the pattern the mailbox name must
match.
subscribed. This is almost identical to
<function>imap_listmailbox</function>, but will only return
mailboxes the user you logged in as has subscribed.
</para>
</refsect1>
</refentry>
@ -764,7 +856,7 @@ fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>string <parameter>msglist</parameter></paramdef>
<paramdef>string <parameter>mbox</parameter></paramdef>
<paramdef>int <parameter>flags</parameter></paramdef>
<paramdef>int <parameter><optional>flags</optional></parameter></paramdef>
</funcsynopsis>
<para>
Returns true on success and false on error.
@ -772,7 +864,8 @@ fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter>
<para>
Copies mail messages specified by <parameter>msglist</parameter>
to specified mailbox. <parameter>msglist</parameter> is a range
not just message numbers.
not just message numbers (as described in
<ulink url="&url.rfc;/rfc2060.html">RFC2060</ulink>).
</para>
<para>
Flags is a bitmask of one or more of
@ -805,11 +898,23 @@ fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>string <parameter>msglist</parameter></paramdef>
<paramdef>string <parameter>mbox</parameter></paramdef>
<paramdef>int <parameter><optional>flags</optional></parameter></paramdef>
</funcsynopsis>
<para>
Moves mail messages specified by <parameter>msglist</parameter>
to specified mailbox. <parameter>msglist</parameter> is a range
not just message numbers.
not just message numbers (as described in
<ulink url="&url.rfc;/rfc2060.html">RFC2060</ulink>).
</para>
<para>
Flags is a bitmask and may contain the single option
<itemizedlist>
<listitem>
<simpara>
CP_UID - the sequence numbers contain UIDS
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
Returns true on success and false on error.
@ -866,7 +971,7 @@ fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter>
<paramdef>string <parameter>mailbox</parameter></paramdef>
<paramdef>string <parameter>username</parameter></paramdef>
<paramdef>string <parameter>password</parameter></paramdef>
<paramdef>int <parameter>flags</parameter></paramdef>
<paramdef>int <parameter><optional>flags</optional></parameter></paramdef>
</funcsynopsis>
<para>
Returns an IMAP stream on success and false on error. This
@ -908,7 +1013,7 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
</listitem>
<listitem>
<simpara>
OP_ANONYMOUS - Dont use or update a .newsrc for news
OP_ANONYMOUS - Dont use or update a .newsrc for news (NNTP only)
</simpara>
</listitem>
<listitem>
@ -924,6 +1029,34 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
</listitem>
</itemizedlist>
</para>
<para>
<example>
<title><function>imap_open</function> example</title>
<programlisting>
$mbox = imap_open("{your.imap.host:143}","username","password");
echo "&lt;p&gt;&lt;h1&gt;Mailboxes&lt;/h1&gt;\n";
$folders = imap_listmailbox($mbox, "{your.imap.host:143}", "*");
if($folders == false)
echo "Call failed&lt;br&gt;\n";
else
while(list($key,$val) = each($folders))
echo $val."&lt;br&gt;\n";
echo "&lt;p&gt;&lt;h1&gt;Headers in INBOX&lt;/h1&gt;\n";
$headers = imap_headers($mbox);
if($headers == false)
echo "Call failed&lt;br&gt;\n";
else
while(list($key,$val) = each($headers))
echo $val."&lt;br&gt;\n";
imap_close($mbox);
</programlisting>
</example>
</para>
</refsect1>
</refentry>
@ -945,7 +1078,9 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<function>imap_ping</function> function pings the stream to see
it is still active. It may discover new mail; this is the
preferred method for a periodic "new mail check" as well as a
"keep alive" for servers which have inactivity timeout.
"keep alive" for servers which have inactivity timeout
( As PHP scripts do not tend to run that long, i can hardly
immagine that this function will be usefull to anyone ).
</para>
</refsect1>
</refentry>
@ -972,8 +1107,10 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
Returns true on success and false on error.
</para>
<para>
See also <function>imap_createmailbox</function> and
<function>imap_deletemailbox</function>.
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>
@ -992,10 +1129,10 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<paramdef>string
<parameter><optional>flags</optional></parameter></paramdef>
</funcsynopsis>
<para>
Returns true on success and false on error.</para>
<para>
This function reopens the specified stream to new mailbox.</para>
This function reopens the specified stream to a new mailbox on
an IMAP or NNTP server.
</para>
<para>
The options are a bit mask with one or more of the following:
<itemizedlist>
@ -1006,7 +1143,7 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
</listitem>
<listitem>
<simpara>
OP_ANONYMOUS - Dont use or update a .newsrc for news
OP_ANONYMOUS - Dont use or update a .newsrc for news (NNTP only)
</simpara>
</listitem>
<listitem>
@ -1018,10 +1155,15 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<listitem>
<simpara>
CL_EXPUNGE - Expunge mailbox automatically upon mailbox close
( see also <function>imap_delete</function> and
<function>imap_expunge</function> )
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
Returns true on success and false on error.
</para>
</refsect1>
</refentry>
@ -1062,7 +1204,8 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
</funcsynopsis>
<para>
This function removes the deletion flag for a specified message,
which is set by <function>imap_delete</function>.
which is set by <function>imap_delete</function> or
<function>imap_mail_move</function>.
</para>
<para>
Returns true on success and false on error.
@ -1104,9 +1247,15 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<paramdef>string <parameter>string</parameter></paramdef>
</funcsynopsis>
<para>
Convert a quoted-printable string to an 8 bit string</para>
Convert a quoted-printable string to an 8 bit string
( according to <ulink url="&url.rfc;/rfc2045.html">RFC2045</ulink>, section 6.7 ).
</para>
<para>
Returns an 8 bit (binary) string</para>
Returns an 8 bit (binary) string.
</para>
<para>
See also <function>imap_8bit</function>.
</para>
</refsect1>
</refentry>
@ -1124,9 +1273,17 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<paramdef>string <parameter>string</parameter></paramdef>
</funcsynopsis>
<para>
Convert an 8bit string to a quoted-printable string.</para>
Convert an 8bit string to a quoted-printable string.
( according to
<ulink url="&url.rfc;/rfc2045.html">RFC2045</ulink>,
section 6.7 ).
</para>
<para>
Returns a quoted-printable string</para>
Returns a quoted-printable string
</para>
<para>
See also <function>imap_qprint</function>.
</para>
</refsect1>
</refentry>
@ -1144,11 +1301,17 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<paramdef>string <parameter>string</parameter></paramdef>
</funcsynopsis>
<para>
Convert an 8bit string to a base64 string.
Convert an 8bit string to a base64 string
(according to
<ulink url="&url.rfc;/rfc2045.html">RFC2045</ulink>,
Section 6.8).
</para>
<para>
Returns a base64 string.
</para>
<para>
See also <function>imap_base64</function>.
</para>
</refsect1>
</refentry>
@ -1165,11 +1328,14 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<funcsynopsis>
<funcdef>array <function>imap_scanmailbox</function></funcdef>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>string <parameter>string</parameter></paramdef>
<paramdef>string <parameter>content</parameter></paramdef>
</funcsynopsis>
<para>
Returns an array containing the names of the mailboxes that have
<parameter>string</parameter> in the text of the mailbox.
This function is simmilar to <function>imap_listmailbox</function>,
but it will additionally check for the presence of the string
<parameter>content</parameter> inside the mailbox data.
</para>
</refsect1>
</refentry>
@ -1191,21 +1357,27 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
</para>
<para>
The <function>imap_mailboxmsginfo</function> function checks the
current mailbox status on the server and returns the information
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>
<informalexample>
<literallayout>
Date : date of the message
Driver : driver
Mailbox : name of the mailbox
Nmsgs : number of messages
Recent : number of recent messages
Unread : number of unread messages
Size : mailbox size
</literallayout>
</informalexample>
<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>Size </entry><entry>mailbox size </entry></row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
</refentry>
@ -1229,8 +1401,9 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<paramdef>string <parameter>personal</parameter></paramdef>
</funcsynopsis>
<para>
Returns a properly formatted email address given the mailbox,
host, and personal info.
Returns a properly formatted email address as defined in
<ulink url="&url.rfc;/rfc822.html">RFC822</ulink>
given the mailbox, host, and personal info.
</para>
</refsect1>
</refentry>
@ -1250,8 +1423,10 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<paramdef>string <parameter>default_host</parameter></paramdef>
</funcsynopsis>
<para>
This function parses the address string and for each address,
returns an array of objects. The 4 objects are:
This function parses the address string as defined in
<ulink url="&url.rfc;/rfc822.html">RFC822</ulink> and
for each address, returns an array of objects.
The 4 objects are:
</para>
<para>
<informalexample>
@ -1320,6 +1495,9 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<para>
This function causes a store to delete the specified flag to the
flags set for the messages in the specified sequence.
The flags which you can unset are "\\Seen", "\\Answered",
"\\Flagged", "\\Deleted", "\\Draft", and "\\Recent" ( as defined
by RFC2060)
</para>
<para>
The options are a bit mask with one or more of the following:
@ -1394,7 +1572,8 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<paramdef>int <parameter>flags</parameter></paramdef>
</funcsynopsis>
<para>
This function causes a fetch of the complete, unfiltered RFC 822
This function causes a fetch of the complete, unfiltered
<ulink url="&url.rfc;/rfc822.html">RFC822</ulink>
format header of the specified message as a text string and
returns that text string.
</para>
@ -1434,7 +1613,10 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
</funcsynopsis>
<para>
This function returns the UID for the given message sequence
number. It is the inverse of <function>imap_msgno</function>.
number. An UID is an 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>
</refsect1>
</refentry>
@ -1614,7 +1796,7 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
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 uncomplete or
inaccurate. Searcher beware.
inaccurate (see also RFC2060, section 6.4.4).
</para>
<para>
Valid values for flags are SE_UID, which causes the returned
@ -1644,8 +1826,6 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
subsequently, with no intervening errors, will return the same
error.
</para>
<para>CAUTION: this function is not yet available in PHP4.
</para>
</refsect1>
</refentry>
@ -1671,9 +1851,6 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<function>imap_errors</function> is called, the error stack is
subsequently cleared.
</para>
<para>
CAUTION: this function is not yet available in PHP4
</para>
</refsect1>
</refentry>
@ -1785,7 +1962,10 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
</para>
<para>
Returns the decoded 8bit data, or false if the input string was
not valid modified UTF-7.
not valid modified UTF-7. The modified UTF-7 encoding is defined in
<ulink url="&url.rfc;/rfc2060.html">RFC 2060</ulink>, section 5.1.3
(original UTF-7 was defned in
<ulink url="&url.rfc;/rfc1642.html">RFC1642</ulink>).
</para>
</refsect1>
</refentry>
@ -1806,7 +1986,9 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
<para>
Converts 8bit <parameter>data</parameter> to modified
UTF-7 text. The modified UTF-7 encoding is defined in
RFC 2060.
<ulink url="&url.rfc;/rfc2060.html">RFC 2060</ulink>, section 5.1.3
(original UTF-7 was defned in
<ulink url="&url.rfc;/rfc1642.html">RFC1642</ulink>).
</para>
<para>
Returns the modified UTF-7 text.
@ -1814,6 +1996,164 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
</refsect1>
</refentry>
<refentry id="function.imap-utf8">
<refnamediv>
<refname>imap_utf8</refname>
<refpurpose>
Converts text to UTF8
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>string <function>imap_utf8</function></funcdef>
<paramdef>string <parameter>text</parameter></paramdef>
</funcsynopsis>
<para>
Converts the given <parameter>text</parameter> to
UTF8 (as defined in
<ulink url="&url.rfc;/rfc2044.html">RFC2044</ulink>).
</para>
</refsect1>
</refentry>
<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>
<funcsynopsis>
<funcdef>array <function>imap_fetch_overview</function></funcdef>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>string <parameter>sequence</parameter></paramdef>
</funcsynopsis>
<para>
This function fetches a mail header and returns an overview of its contents.
It will return 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>
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>
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 maibox
</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>
</refsect1>
</refentry>
<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>
<funcsynopsis>
<funcdef>string <function>imap_mail_compose</function></funcdef>
<paramdef>array <parameter>envelope</parameter></paramdef>
<paramdef>array <parameter>body</parameter></paramdef>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-mail">
<refnamediv>
<refname>imap_mail</refname>
<refpurpose>
Send an email message
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>string <function>imap_mail</function></funcdef>
<paramdef>string <parameter>to</parameter></paramdef>
<paramdef>string <parameter>subject</parameter></paramdef>
<paramdef>string <parameter>message</parameter></paramdef>
<paramdef>string <parameter><optional>additional_headers</optional></parameter></paramdef>
<paramdef>string <parameter><optional>cc</optional></parameter></paramdef>
<paramdef>string <parameter><optional>bcc</optional></parameter></paramdef>
<paramdef>string <parameter><optional>rpath</optional></parameter></paramdef>
</funcsynopsis>
<para>
This function is currently only available in PHP3.
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file