mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
3a2da7cbd8
CS Replaced <programlisting> ... with <listitem> Added constant/parameter tags Added See Also parts Used &return.success; Added some para to make the whole thing more easy to read Removed redundancy git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@153120 c90b9560-bf6c-de11-be94-00142212c4b1
98 lines
2.9 KiB
XML
98 lines
2.9 KiB
XML
<?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-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
|
|
|
|
$mbox = imap_open("{your.imap.host}INBOX", "username", "password")
|
|
or die("Can't connect: " . imap_last_error());
|
|
|
|
$check = imap_mailboxmsginfo($mbox);
|
|
echo "Messages before delete: " . $check->Nmsgs . "<br />\n";
|
|
|
|
imap_delete($mbox, 1);
|
|
|
|
$check = imap_mailboxmsginfo($mbox);
|
|
echo "Messages after delete: " . $check->Nmsgs . "<br />\n";
|
|
|
|
imap_expunge($mbox);
|
|
|
|
$check = imap_mailboxmsginfo($mbox);
|
|
echo "Messages after expunge: " . $check->Nmsgs . "<br />\n";
|
|
|
|
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>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|