reference/imap/functions/imap-delete.xml
673d373eda1740843eaef88e9665eb887f6f5752
...
...
@@ -8,7 +8,7 @@
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
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>
...
...
@@ -49,10 +49,19 @@
49
49
</variablelist>
50
50
</para>
51
51
</refsect1>
52
+

52
53
<refsect1 role="returnvalues">
53
54
&reftitle.returnvalues;
54
55
<para>
55
-
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.
56
65
</para>
57
66
</refsect1>
58
67

...
...
@@ -68,6 +77,14 @@
68
77
</thead>
69
78
<tbody>
70
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>
71
88
</tbody>
72
89
</tgroup>
73
90
</informaltable>
74
91