reference/imap/functions/imap-gc.xml
673d373eda1740843eaef88e9665eb887f6f5752
673d373eda1740843eaef88e9665eb887f6f5752
...
...
@@ -8,7 +8,7 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>bool</type><methodname>imap_gc</methodname>
11
+
<type>true</type><methodname>imap_gc</methodname>
12
12
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
13
13
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
14
14
</methodsynopsis>
...
...
@@ -36,10 +36,19 @@
36
36
</variablelist>
37
37
</para>
38
38
</refsect1>
39
+
39
40
<refsect1 role="returnvalues">
40
41
&reftitle.returnvalues;
41
42
<para>
42
-
&return.success;
43
+
&return.true.always;
44
+
</para>
45
+
</refsect1>
46
+
47
+
<refsect1 role="errors">
48
+
&reftitle.errors;
49
+
<para>
50
+
Throws a <classname>ValueError</classname> if <parameter>flags</parameter>
51
+
is invalid.
43
52
</para>
44
53
</refsect1>
45
54
...
...
@@ -55,6 +64,14 @@
55
64
</thead>
56
65
<tbody>
57
66
&imap.changelog.imap-param;
67
+
<row>
68
+
<entry>8.0.0</entry>
69
+
<entry>
70
+
A <classname>ValueError</classname> is now thrown on invalid
71
+
<parameter>flags</parameter> parameter values. Previously,
72
+
a warning was emitted and the function returned &false;.
73
+
</entry>
74
+
</row>
58
75
</tbody>
59
76
</tgroup>
60
77
</informaltable>
61
78