1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
<?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">
<![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>
<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
-->
|
