-
Notifications
You must be signed in to change notification settings - Fork 56
/
imap-status.xml
169 lines (165 loc) · 5.22 KB
/
imap-status.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
161
162
163
164
165
166
167
168
169
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.imap-status" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_status</refname>
<refpurpose>現在のメールボックス以外のメールボックスのステータス情報を返す</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_status</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
指定したメールボックス <parameter>mailbox</parameter>
についてのステータス情報を取得します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>mailbox</parameter></term>
<listitem>
<para>
メールボックス名。詳細は <function>imap_open</function>
を参照ください。
</para>
&imap.mailboxname.insecure;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
以下のフラグが使用できます。
<itemizedlist>
<listitem>
<simpara>
<constant>SA_MESSAGES</constant> -
<varname>$status->messages</varname> にメールボックスのメッセージ数を設定する
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SA_RECENT</constant> -
<varname>$status->recent</varname> にメールボックスの最近のメッセージ数を設定する
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SA_UNSEEN</constant> -
<varname>$status->unseen</varname> にメールボックスの未読の(新規)メッセージ数を設定する
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SA_UIDNEXT</constant> -
<varname>$status->uidnext</varname> にメールボックスの次の UID を設定する
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SA_UIDVALIDITY</constant> - メールボックスの UID
がもはや有効ではない場合に変化する定数を <varname>$status->uidvalidity</varname> に設定する
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SA_ALL</constant> - 上記のものをすべて設定する
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
この関数は、ステータス情報を含むオブジェクトを返します。
&return.falseforfailure;。
このオブジェクトには
<literal>messages</literal>、
<literal>recent</literal>、<literal>unseen</literal>、
<literal>uidnext</literal> および <literal>uidvalidity</literal>
というプロパティが含まれます。
</para>
<para>
<literal>flags</literal> にも、
上の各定数に対応するビットマスクを設定することができます。
</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;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>imap_status</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)
or die("接続できません: " . imap_last_error());
$status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);
if ($status) {
echo "Messages: " . $status->messages . "<br />\n";
echo "Recent: " . $status->recent . "<br />\n";
echo "Unseen: " . $status->unseen . "<br />\n";
echo "UIDnext: " . $status->uidnext . "<br />\n";
echo "UIDvalidity:" . $status->uidvalidity . "<br />\n";
} else {
echo "imap_status failed: " . imap_last_error() . "\n";
}
imap_close($mbox);
?>
]]>
</programlisting>
</example>
</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
-->