PHP - imap_status() 函式

PHP 的 IMAP 函式幫助您訪問電子郵件帳戶，IMAP 代表 **I**nternet **M**ail **A**ccess **P**rotocol，使用這些函式，您還可以使用 NNTP、POP3 協議和本地郵箱訪問方法。

imap_status() 函式接受表示 IMAP 流的資源值、表示郵箱 URL/名稱的字串值以及表示可選值的整數作為引數，檢索並返回給定郵箱的狀態。

語法

imap_status($imap_stream, $mailbox, $options);

引數

序號	引數及描述
1	imap_stream (必填) 這是一個字串值，表示 IMAP 流，是 imap_open() 函式的返回值。
2	mailbox (必填) 這是一個字串值，表示郵箱的名稱/URL。它包含伺服器名稱和郵箱路徑。
3	options (必填) 這是一個整數值，表示可選引數，可以是以下之一： SA_MESSAGES SA_RECENT SA_UNSEEN SA_UIDNEXT SA_UIDVALIDITY _subscribed SA_ALL

序號

引數及描述

imap_stream (必填)

這是一個字串值，表示 IMAP 流，是 imap_open() 函式的返回值。

mailbox (必填)

這是一個字串值，表示郵箱的名稱/URL。它包含伺服器名稱和郵箱路徑。

options (必填)

這是一個整數值，表示可選引數，可以是以下之一：

SA_MESSAGES
SA_RECENT
SA_UNSEEN
SA_UIDNEXT
SA_UIDVALIDITY _subscribed
SA_ALL

返回值

此函式返回一個物件，其中包含給定郵箱的狀態資訊。

PHP 版本

此函式首次在 PHP 4 版本中引入，並在所有後續版本中均有效。

示例

以下示例演示了 imap_status() 函式的用法：

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
         
         //Status info of the mailbox
         $info = imap_status($imap, $url, SA_ALL);
         print_r($info);
		 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

輸出

這將生成以下輸出：

Connection established....
stdClass Object ( 
   [flags] => 31 [messages] => 12 [recent] => 0 
   [unseen] => 2 [uidnext] => 61 [uidvalidity] => 1 
)

示例

以下是上述函式的另一個示例：

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
         
         //Status info of the mailbox
         print_r(imap_status($imap, $url, SA_MESSAGES));
         print("<br>");
         print_r(imap_status($imap, $url, SA_RECENT));
         print("<br>");
         print_r(imap_status($imap, $url, SA_UNSEEN));
         print("<br>");
         print_r(imap_status($imap, $url, SA_UIDNEXT));
         print("<br>");
         print_r(imap_status($imap, $url, SA_UIDVALIDITY));
         print("<br>");
         print_r(imap_status($imap, $url, SA_ALL));
		   
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

輸出

這將生成以下輸出：

Connection established....
stdClass Object ( [flags] => 1 [messages] => 12 )
stdClass Object ( [flags] => 2 [recent] => 0 )
stdClass Object ( [flags] => 4 [unseen] => 2 )
stdClass Object ( [flags] => 8 [uidnext] => 61 )
stdClass Object ( [flags] => 16 [uidvalidity] => 1 )
stdClass Object ( [flags] => 31 [messages] => 12 [recent] => 0 [unseen] => 2 [uidnext] => 61 [uidvalidity] => 1 )

php_function_reference.htm

列印頁面