-
Notifications
You must be signed in to change notification settings - Fork 72
/
imap-setflag-full.xml
160 lines (153 loc) · 5.12 KB
/
imap-setflag-full.xml
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 673d373eda1740843eaef88e9665eb887f6f5752 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-setflag-full" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>imap_setflag_full</refname>
<refpurpose>Устанавливает флаги на сообщения</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>true</type><methodname>imap_setflag_full</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>sequence</parameter></methodparam>
<methodparam><type>string</type><parameter>flag</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Сообщает серверу, что надо добавить флаг <parameter>flag</parameter> к набору
флагов, заданным в <parameter>sequence</parameter> сообщениям.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>sequence</parameter></term>
<listitem>
<para>
Последовательность номеров сообщений.Вы можете перечислить несколько
сообщений, используя как разделитель запятую (<literal>X,Y</literal>), или
задать интервал сообщений с помощью двоеточия <literal>X:Y</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flag</parameter></term>
<listitem>
<para>
Флаги, которые можно установить: <literal>\Seen</literal>,
<literal>\Answered</literal>, <literal>\Flagged</literal>,
<literal>\Deleted</literal> и <literal>\Draft</literal>, как определено
в <link xlink:href="&url.rfc;2060">RFC2060</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Битовая маска, которая может принимать только одно значение:
<itemizedlist>
<listitem>
<simpara>
<constant>ST_UID</constant> - последовательность сообщений задана
не их номерами, а с помощью UID
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.true.always;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Выбрасывает исключение <classname>ValueError</classname>,
если значение параметра <parameter>options</parameter> недопустимо.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&imap.changelog.imap-param;
<row>
<entry>8.0.0</entry>
<entry>
Теперь выбрасывается исключение <classname>ValueError</classname>
при недопустимых значениях параметра <parameter>options</parameter>.
Ранее возникало предупреждение и функция возвращала логическое значение &false;.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>imap_setflag_full</function></title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password")
or die("не удалось подключиться: " . imap_last_error());
$status = imap_setflag_full($mbox, "2,5", "\\Seen \\Flagged");
echo gettype($status) . "\n";
echo $status . "\n";
imap_close($mbox);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_clearflag_full</function></member>
</simplelist>
</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:"~/.phpdoc/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
-->