<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <HTML ><HEAD ><TITLE >imap_getsubscribed</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_getmailboxes" HREF="function.imap-getmailboxes.html"><LINK REL="NEXT" TITLE="imap_header" HREF="function.imap-header.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-getmailboxes.html" ACCESSKEY="P" >上一页</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="function.imap-header.html" ACCESSKEY="N" >下一页</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="function.imap-getsubscribed" ></A >imap_getsubscribed</H1 ><DIV CLASS="refnamediv" ><A NAME="AEN96651" ></A ><P > (PHP 3 >= 3.0.12, PHP 4, PHP 5)</P >imap_getsubscribed -- List all the subscribed mailboxes</DIV ><DIV CLASS="refsect1" ><A NAME="AEN96654" ></A ><H2 >说明</H2 >array <B CLASS="methodname" >imap_getsubscribed</B > ( resource imap_stream, string ref, string pattern )<BR ></BR ><P > Gets information on the subscribeds mailboxes. </P ><P > Identical to <A HREF="function.imap-getmailboxes.html" ><B CLASS="function" >imap_getmailboxes()</B ></A >, except that it only returns mailboxes that the user is subscribed to. </P ></DIV ><DIV CLASS="refsect1" ><A NAME="AEN96671" ></A ><H2 >参数</H2 ><P > <P ></P ><DIV CLASS="variablelist" ><DL ><DT ><CODE CLASS="parameter" > 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 > <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 > Specifies where in the mailbox hierarchy to start searching. </P ><P > 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="AEN96697" ></A ><H2 >返回值</H2 ><P > 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 > <TT CLASS="constant" ><B >LATT_NOINFERIORS</B ></TT > - This mailbox has no "children" (there are no mailboxes below this one). </P ></LI ><LI ><P > <TT CLASS="constant" ><B >LATT_NOSELECT</B ></TT > - This is only a container, not a mailbox - you cannot open it. </P ></LI ><LI ><P > <TT CLASS="constant" ><B >LATT_MARKED</B ></TT > - This mailbox is marked. Only used by UW-IMAPD. </P ></LI ><LI ><P > <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="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-getmailboxes.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-header.html" ACCESSKEY="N" >下一页</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >imap_getmailboxes</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_header</TD ></TR ></TABLE ></DIV ></BODY ></HTML >