/
imap-listscan.xml
115 lines (113 loc) · 3.31 KB
/
imap-listscan.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.imap-listscan" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_listscan</refname>
<refpurpose>指定したテキストにマッチするメールボックスの一覧を返す</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>imap_listscan</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>reference</parameter></methodparam>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
<para>
<parameter>content</parameter> をテキストに持つメールボックスの名前を
配列で返します。
</para>
<para>
この関数は <function>imap_listmailbox</function> に似ていますが、
メールボックス内に文字列 <parameter>content</parameter> が存在するか
どうかを調べる点が違います。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>reference</parameter></term>
<listitem>
<para>
通常、<parameter>reference</parameter> は
<function>imap_open</function> で述べられているサーバー定義です。
</para>
&imap.mailboxname.insecure;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
&imap.pattern;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
検索する文字列。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<parameter>content</parameter> をテキストに持つメールボックスの名前を配列で返します。
&return.falseforfailure;
</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="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_listmailbox</function></member>
<member><function>imap_search</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
-->