File: imap-clearflag-full.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (63 lines) | stat: -rw-r--r-- 2,115 bytes parent folder | download
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 -->
  <refentry id="function.imap-clearflag-full">
   <refnamediv>
    <refname>imap_clearflag_full</refname>
    <refpurpose>Clears flags on messages</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>imap_clearflag_full</methodname>
      <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>sequence</parameter></methodparam>
      <methodparam><type>string</type><parameter>flag</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function causes a store to delete the specified 
     <parameter>flag</parameter> to the flags set for the
     messages in the specified <parameter>sequence</parameter>.
     The flags which you can unset are "\\Seen", "\\Answered",
     "\\Flagged", "\\Deleted", and "\\Draft" (as defined
     by <ulink url="&url.rfc;2060">RFC2060</ulink>). &return.success;.
    </para>
    <para>
     <parameter>options</parameter> are a bit mask and may contain 
     the single option:
     <itemizedlist>
      <listitem>
       <simpara>
        <constant>ST_UID</constant> - The sequence argument contains UIDs 
        instead of sequence numbers
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     See also: <function>imap_setflag_full</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
-->