Sophie

Sophie

distrib > Mandriva > 2008.1 > i586 > by-pkgid > 703d980c580707c382b4e43e25965bc5 > files > 7319

php-manual-pt_BR-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_status</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Manual do PHP"
HREF="index.html"><LINK
REL="UP"
TITLE="IMAP, POP3 and NNTP Functions"
HREF="ref.imap.html"><LINK
REL="PREVIOUS"
TITLE="imap_sort"
HREF="function.imap-sort.html"><LINK
REL="NEXT"
TITLE="imap_subscribe"
HREF="function.imap-subscribe.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"
>Manual do PHP</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.imap-sort.html"
ACCESSKEY="P"
>Anterior</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.imap-subscribe.html"
ACCESSKEY="N"
>Próxima</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.imap-status"
></A
>imap_status</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN95257"
></A
><P
>    (PHP 3 &#62;= 3.0.4, PHP 4, PHP 5)</P
>imap_status&nbsp;--&nbsp;Returns status information on a mailbox</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN95260"
></A
><H2
>Descrição</H2
>object <B
CLASS="methodname"
>imap_status</B
> ( resource imap_stream, string mailbox, int options )<BR
></BR
><P
>&#13;   Gets status information about the given <CODE
CLASS="parameter"
>mailbox</CODE
>.
  </P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN95276"
></A
><H2
>Parâmetros</H2
><P
>&#13;   <P
></P
><DIV
CLASS="variablelist"
><DL
><DT
><CODE
CLASS="parameter"
>&#13; imap_stream</CODE
></DT
><DD
><P
>Um stream IMAP retornado por
 <A
HREF="function.imap-open.html"
><B
CLASS="function"
>imap_open()</B
></A
>.</P
></DD
><DT
><CODE
CLASS="parameter"
>mailbox</CODE
></DT
><DD
><P
>&#13;       The mailbox name, see <A
HREF="function.imap-open.html"
><B
CLASS="function"
>imap_open()</B
></A
> for more
       information
      </P
></DD
><DT
><CODE
CLASS="parameter"
>options</CODE
></DT
><DD
><P
>&#13;       Valid flags are:
       <P
></P
><UL
><LI
><P
>&#13;          <TT
CLASS="constant"
><B
>SA_MESSAGES</B
></TT
> - set status-&#62;messages to the
          number of messages in the mailbox
         </P
></LI
><LI
><P
>&#13;          <TT
CLASS="constant"
><B
>SA_RECENT</B
></TT
> - set status-&#62;recent to the number
          of recent messages in the mailbox
         </P
></LI
><LI
><P
>&#13;          <TT
CLASS="constant"
><B
>SA_UNSEEN</B
></TT
> - set status-&#62;unseen to the number
          of unseen (new) messages in the mailbox
         </P
></LI
><LI
><P
>&#13;          <TT
CLASS="constant"
><B
>SA_UIDNEXT</B
></TT
> - set status-&#62;uidnext to the next
          uid to be used in the mailbox
         </P
></LI
><LI
><P
>&#13;          <TT
CLASS="constant"
><B
>SA_UIDVALIDITY</B
></TT
> - set status-&#62;uidvalidity to a
          constant that changes when uids for the mailbox may no longer be
          valid
         </P
></LI
><LI
><P
>&#13;          <TT
CLASS="constant"
><B
>SA_ALL</B
></TT
> - set all of the above
         </P
></LI
></UL
>
      </P
></DD
></DL
></DIV
>
  </P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN95316"
></A
><H2
>Valores de retornado</H2
><P
>&#13;   This function returns an object containing status information.
   The object has the following properties: <TT
CLASS="literal"
>messages</TT
>,
   <TT
CLASS="literal"
>recent</TT
>, <TT
CLASS="literal"
>unseen</TT
>, 
   <TT
CLASS="literal"
>uidnext</TT
>, and <TT
CLASS="literal"
>uidvalidity</TT
>.  
  </P
><P
>&#13;   <TT
CLASS="literal"
>flags</TT
> is also set, which contains a bitmask which can
   be checked against any of the above constants.
  </P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN95326"
></A
><H2
>Exemplos</H2
><P
>&#13;   <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN95329"
></A
><P
><B
>Exemplo 1. <B
CLASS="function"
>imap_status()</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.com}"</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">$status </font><font color="#007700">= </font><font color="#0000BB">imap_status</font><font color="#007700">(</font><font color="#0000BB">$mbox</font><font color="#007700">, </font><font color="#DD0000">"{imap.example.org}INBOX"</font><font color="#007700">, </font><font color="#0000BB">SA_ALL</font><font color="#007700">);<br />if (</font><font color="#0000BB">$status</font><font color="#007700">) {<br />&nbsp;&nbsp;echo </font><font color="#DD0000">"Messages:&nbsp;&nbsp;&nbsp;" </font><font color="#007700">. </font><font color="#0000BB">$status</font><font color="#007700">-&gt;</font><font color="#0000BB">messages&nbsp;&nbsp;&nbsp;&nbsp;</font><font color="#007700">. </font><font color="#DD0000">"&lt;br /&gt;\n"</font><font color="#007700">;<br />&nbsp;&nbsp;echo </font><font color="#DD0000">"Recent:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;" </font><font color="#007700">. </font><font color="#0000BB">$status</font><font color="#007700">-&gt;</font><font color="#0000BB">recent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</font><font color="#007700">. </font><font color="#DD0000">"&lt;br /&gt;\n"</font><font color="#007700">;<br />&nbsp;&nbsp;echo </font><font color="#DD0000">"Unseen:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;" </font><font color="#007700">. </font><font color="#0000BB">$status</font><font color="#007700">-&gt;</font><font color="#0000BB">unseen&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</font><font color="#007700">. </font><font color="#DD0000">"&lt;br /&gt;\n"</font><font color="#007700">;<br />&nbsp;&nbsp;echo </font><font color="#DD0000">"UIDnext:&nbsp;&nbsp;&nbsp;&nbsp;" </font><font color="#007700">. </font><font color="#0000BB">$status</font><font color="#007700">-&gt;</font><font color="#0000BB">uidnext&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</font><font color="#007700">. </font><font color="#DD0000">"&lt;br /&gt;\n"</font><font color="#007700">;<br />&nbsp;&nbsp;echo </font><font color="#DD0000">"UIDvalidity:" </font><font color="#007700">. </font><font color="#0000BB">$status</font><font color="#007700">-&gt;</font><font color="#0000BB">uidvalidity </font><font color="#007700">. </font><font color="#DD0000">"&lt;br /&gt;\n"</font><font color="#007700">;<br />} else {<br />&nbsp;&nbsp;echo </font><font color="#DD0000">"imap_status 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="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-sort.html"
ACCESSKEY="P"
>Anterior</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Principal</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.imap-subscribe.html"
ACCESSKEY="N"
>Próxima</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>imap_sort</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.imap.html"
ACCESSKEY="U"
>Acima</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>imap_subscribe</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>