reference/imap/functions/imap-delete.xml
673d373eda1740843eaef88e9665eb887f6f5752
673d373eda1740843eaef88e9665eb887f6f5752
...
...
@@ -8,13 +8,13 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>bool</type><methodname>imap_delete</methodname>
11
+
<type>true</type><methodname>imap_delete</methodname>
12
12
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
13
-
<methodparam><type>string</type><parameter>message_num</parameter></methodparam>
13
+
<methodparam><type>string</type><parameter>message_nums</parameter></methodparam>
14
14
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
-
Marks messages listed in <parameter>message_num</parameter> for deletion.
17
+
Marks messages listed in <parameter>message_nums</parameter> for deletion.
18
18
Messages marked for deletion will stay in the mailbox until either
19
19
<function>imap_expunge</function> is called or
20
20
<function>imap_close</function> is called with the optional parameter
...
...
@@ -27,10 +27,12 @@
27
27
<variablelist>
28
28
&imap.imap-parameter.imap;
29
29
<varlistentry>
30
-
<term><parameter>message_num</parameter></term>
30
+
<term><parameter>message_nums</parameter></term>
31
31
<listitem>
32
32
<para>
33
-
The message number
33
+
A &string; representing one or more messages in IMAP4-style sequence format
34
+
(<literal>"n"</literal>, <literal>"n:m"</literal>, or combination of these
35
+
delimited by commas).
34
36
</para>
35
37
</listitem>
36
38
</varlistentry>
...
...
@@ -39,7 +41,7 @@
39
41
<listitem>
40
42
<para>
41
43
You can set the <constant>FT_UID</constant> which tells the function
42
-
to treat the <parameter>message_num</parameter> argument as a
44
+
to treat the <parameter>message_nums</parameter> argument as a
43
45
<literal>UID</literal>.
44
46
</para>
45
47
</listitem>
...
...
@@ -47,10 +49,19 @@
47
49
</variablelist>
48
50
</para>
49
51
</refsect1>
52
+
50
53
<refsect1 role="returnvalues">
51
54
&reftitle.returnvalues;
52
55
<para>
53
-
Returns &true;.
56
+
&return.true.always;
57
+
</para>
58
+
</refsect1>
59
+
60
+
<refsect1 role="errors">
61
+
&reftitle.errors;
62
+
<para>
63
+
Throws a <classname>ValueError</classname> if <parameter>flags</parameter>
64
+
is invalid.
54
65
</para>
55
66
</refsect1>
56
67
...
...
@@ -66,6 +77,14 @@
66
77
</thead>
67
78
<tbody>
68
79
&imap.changelog.imap-param;
80
+
<row>
81
+
<entry>8.0.0</entry>
82
+
<entry>
83
+
A <classname>ValueError</classname> is now thrown on invalid
84
+
<parameter>flags</parameter> parameter values. Previously,
85
+
a warning was emitted and the function returned &false;.
86
+
</entry>
87
+
</row>
69
88
</tbody>
70
89
</tgroup>
71
90
</informaltable>
72
91