reference/imap/functions/imap-clearflag-full.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_clearflag_full</methodname>
11
+
<type>true</type><methodname>imap_clearflag_full</methodname>
12
12
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
13
13
<methodparam><type>string</type><parameter>sequence</parameter></methodparam>
14
14
<methodparam><type>string</type><parameter>flag</parameter></methodparam>
...
...
@@ -40,8 +40,7 @@
40
40
<listitem>
41
41
<para>
42
42
The flags which you can unset are "\\Seen", "\\Answered", "\\Flagged",
43
-
"\\Deleted", and "\\Draft" (as defined by <link
44
-
xlink:href="&url.rfc;2060">RFC2060</link>)
43
+
"\\Deleted", and "\\Draft" (as defined by <link xlink:href="&url.rfc;2060">RFC2060</link>)
45
44
</para>
46
45
</listitem>
47
46
</varlistentry>
...
...
@@ -65,10 +64,18 @@
65
64
</variablelist>
66
65
</para>
67
66
</refsect1>
67
+
68
68
<refsect1 role="returnvalues">
69
69
&reftitle.returnvalues;
70
70
<para>
71
-
&return.success;
71
+
&return.true.always;
72
+
</para>
73
+
</refsect1>
74
+
75
+
<refsect1 role="errors">
76
+
&reftitle.errors;
77
+
<para>
78
+
Throws a <classname>ValueError</classname> if <parameter>options</parameter> is invalid.
72
79
</para>
73
80
</refsect1>
74
81
...
...
@@ -84,6 +91,14 @@
84
91
</thead>
85
92
<tbody>
86
93
&imap.changelog.imap-param;
94
+
<row>
95
+
<entry>8.0.0</entry>
96
+
<entry>
97
+
A <classname>ValueError</classname> is now thrown on invalid
98
+
<parameter>options</parameter> parameter values. Previously,
99
+
a warning was emitted and the function returned &false;.
100
+
</entry>
101
+
</row>
87
102
</tbody>
88
103
</tgroup>
89
104
</informaltable>
90
105