Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > by-pkgid > 05cd670d8a02b2b4a0ffb1756f2e8308 > files > 1981

php-manual-zh-5.2.4-1mdv2008.1.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>imap_getmailboxes</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="PHP 手册"
HREF="index.html"><LINK
REL="UP"
TITLE="IMAP, POP3 and NNTP Functions"
HREF="ref.imap.html"><LINK
REL="PREVIOUS"
TITLE="imap_getacl"
HREF="function.imap-getacl.html"><LINK
REL="NEXT"
TITLE="imap_getsubscribed"
HREF="function.imap-getsubscribed.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=UTF-8"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP 手册</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.imap-getacl.html"
ACCESSKEY="P"
>上一页</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.imap-getsubscribed.html"
ACCESSKEY="N"
>下一页</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.imap-getmailboxes"
></A
>imap_getmailboxes</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN96573"
></A
><P
>    (PHP 3 &#62;= 3.0.12, PHP 4, PHP 5)</P
>imap_getmailboxes&nbsp;--&nbsp;Read the list of mailboxes, returning detailed information on each one</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN96576"
></A
><H2
>说明</H2
>array <B
CLASS="methodname"
>imap_getmailboxes</B
> ( resource imap_stream, string ref, string pattern )<BR
></BR
><P
>&#13;   Gets information on the mailboxes.
  </P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN96591"
></A
><H2
>参数</H2
><P
>&#13;   <P
></P
><DIV
CLASS="variablelist"
><DL
><DT
><CODE
CLASS="parameter"
>&#13;imap_stream</CODE
></DT
><DD
><P
>An IMAP stream returned by 
<A
HREF="function.imap-open.html"
><B
CLASS="function"
>imap_open()</B
></A
>.</P
></DD
><DT
><CODE
CLASS="parameter"
>ref</CODE
></DT
><DD
><P
>&#13;       <CODE
CLASS="parameter"
>ref</CODE
> should normally be just the server
       specification as described in <A
HREF="function.imap-open.html"
><B
CLASS="function"
>imap_open()</B
></A
>
      </P
></DD
><DT
><CODE
CLASS="parameter"
>pattern</CODE
></DT
><DD
><P
>&#13;       Specifies where in the mailbox hierarchy to start searching.
      </P
><P
>&#13;       There are two special characters you can pass as part of the
       <CODE
CLASS="parameter"
>pattern</CODE
>: '*' and '%'. '*' means to return
       all mailboxes. If you pass <CODE
CLASS="parameter"
>pattern</CODE
> as '*',
       you will get a list of the entire mailbox hierarchy. '%' means to
       return the current level only. '%' as the
       <CODE
CLASS="parameter"
>pattern</CODE
> parameter will return only the top
       level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox
       in the ~/mail directory, but none in subfolders of that
       directory.
      </P
></DD
></DL
></DIV
>
  </P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN96617"
></A
><H2
>返回值</H2
><P
>&#13;   Returns an array of objects containing mailbox information. Each
   object has the attributes <CODE
CLASS="parameter"
>name</CODE
>, specifying
   the full name of the mailbox; <CODE
CLASS="parameter"
>delimiter</CODE
>,
   which is the hierarchy delimiter for the part of the hierarchy
   this mailbox is in; and
   <CODE
CLASS="parameter"
>attributes</CODE
>. <CODE
CLASS="parameter"
>Attributes</CODE
>
   is a bitmask that can be tested against:
   <P
></P
><UL
><LI
><P
>&#13;      <TT
CLASS="constant"
><B
>LATT_NOINFERIORS</B
></TT
> - This mailbox has no
      "children" (there are no mailboxes below this one).
     </P
></LI
><LI
><P
>&#13;      <TT
CLASS="constant"
><B
>LATT_NOSELECT</B
></TT
> - This is only a container,
      not a mailbox - you cannot open it.
     </P
></LI
><LI
><P
>&#13;      <TT
CLASS="constant"
><B
>LATT_MARKED</B
></TT
> - This mailbox is marked.
      Only used by UW-IMAPD.
     </P
></LI
><LI
><P
>&#13;      <TT
CLASS="constant"
><B
>LATT_UNMARKED</B
></TT
> - This mailbox is not marked.
      Only used by UW-IMAPD.
     </P
></LI
></UL
>
  </P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN96637"
></A
><H2
>范例</H2
><P
>&#13;   <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN96640"
></A
><P
><B
>例 1. <B
CLASS="function"
>imap_getmailboxes()</B
> example</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><code><font color="#000000">
<font color="#0000BB">&lt;?php<br />$mbox </font><font color="#007700">= </font><font color="#0000BB">imap_open</font><font color="#007700">(</font><font color="#DD0000">"{imap.example.org}"</font><font color="#007700">, </font><font color="#DD0000">"username"</font><font color="#007700">, </font><font color="#DD0000">"password"</font><font color="#007700">, </font><font color="#0000BB">OP_HALFOPEN</font><font color="#007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or die(</font><font color="#DD0000">"can't connect: " </font><font color="#007700">. </font><font color="#0000BB">imap_last_error</font><font color="#007700">());<br /><br /></font><font color="#0000BB">$list </font><font color="#007700">= </font><font color="#0000BB">imap_getmailboxes</font><font color="#007700">(</font><font color="#0000BB">$mbox</font><font color="#007700">, </font><font color="#DD0000">"{imap.example.org}"</font><font color="#007700">, </font><font color="#DD0000">"*"</font><font color="#007700">);<br />if (</font><font color="#0000BB">is_array</font><font color="#007700">(</font><font color="#0000BB">$list</font><font color="#007700">)) {<br />&nbsp;&nbsp;&nbsp;&nbsp;foreach (</font><font color="#0000BB">$list </font><font color="#007700">as </font><font color="#0000BB">$key </font><font color="#007700">=&gt; </font><font color="#0000BB">$val</font><font color="#007700">) {<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo </font><font color="#DD0000">"($key) "</font><font color="#007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo </font><font color="#0000BB">imap_utf7_decode</font><font color="#007700">(</font><font color="#0000BB">$val</font><font color="#007700">-&gt;</font><font color="#0000BB">name</font><font color="#007700">) . </font><font color="#DD0000">","</font><font color="#007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo </font><font color="#DD0000">"'" </font><font color="#007700">. </font><font color="#0000BB">$val</font><font color="#007700">-&gt;</font><font color="#0000BB">delimiter </font><font color="#007700">. </font><font color="#DD0000">"',"</font><font color="#007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo </font><font color="#0000BB">$val</font><font color="#007700">-&gt;</font><font color="#0000BB">attributes </font><font color="#007700">. </font><font color="#DD0000">"&lt;br /&gt;\n"</font><font color="#007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />} else {<br />&nbsp;&nbsp;&nbsp;&nbsp;echo </font><font color="#DD0000">"imap_getmailboxes failed: " </font><font color="#007700">. </font><font color="#0000BB">imap_last_error</font><font color="#007700">() . </font><font color="#DD0000">"\n"</font><font color="#007700">;<br />}<br /><br /></font><font color="#0000BB">imap_close</font><font color="#007700">(</font><font color="#0000BB">$mbox</font><font color="#007700">);<br /></font><font color="#0000BB">?&gt;</font>
</font>
</code></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
  </P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN96644"
></A
><H2
>参见</H2
><P
>&#13;   <P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
><A
HREF="function.imap-getsubscribed.html"
><B
CLASS="function"
>imap_getsubscribed()</B
></A
></TD
></TR
></TBODY
></TABLE
><P
></P
>
  </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.imap-getacl.html"
ACCESSKEY="P"
>上一页</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>起始页</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.imap-getsubscribed.html"
ACCESSKEY="N"
>下一页</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>imap_getacl</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.imap.html"
ACCESSKEY="U"
>上一级</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>imap_getsubscribed</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>