mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 20:38:56 +00:00
a315422008
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331926 c90b9560-bf6c-de11-be94-00142212c4b1
130 lines
3.6 KiB
XML
130 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.imap-delete" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>imap_delete</refname>
|
|
<refpurpose>Mark a message for deletion from current mailbox</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>imap_delete</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><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Marks messages listed in <parameter>msg_number</parameter> for deletion.
|
|
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
|
|
<constant>CL_EXPUNGE</constant>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&imap.imap-stream.description;
|
|
<varlistentry>
|
|
<term><parameter>msg_number</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The message number
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
You can set the <constant>FT_UID</constant> which tells the function
|
|
to treat the <parameter>msg_number</parameter> argument as an
|
|
<literal>UID</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns &true;.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>imap_delete</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);
|
|
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>
|
|
</refsect1>
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
IMAP mailboxes may not have their message flags saved between connections,
|
|
so <function>imap_expunge</function> should be called during the same
|
|
connection in order to guarantee that messages marked for deletion will
|
|
actually be purged.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>imap_undelete</function></member>
|
|
<member><function>imap_expunge</function></member>
|
|
<member><function>imap_close</function></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|