PHP imap_status()用法及代碼示例

PHP-IMAP 函數可幫助您訪問電子郵件帳戶，IMAP 代表I互聯網M艾爾A訪問權限Protocol 使用這些函數您還可以使用 NNTP、POP3 協議和本地郵箱訪問方法。

這個imap_status()函數接受表示 IMAP 流的資源值、表示郵箱的 url/名稱的字符串值和表示可選值的整數作為參數，檢索並返回給定郵箱的狀態。

用法

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

參數

Sr.No	參數及說明
1	imap_stream (Mandatory) 這是一個表示 IMAP 流的字符串值，返回值imap_open()函數。
2	mailbox(Mandatory) 這是一個字符串值，表示郵箱的名稱/URL。它包含服務器名稱、郵箱路徑。
3	options (Mandatory) 這是一個表示可選參數的整數值，它可以是以下之一： SA_MESSAGES SA_RECENT SA_UNSEEN SA_UIDNEXT SA_UIDVALIDITY _subscribed SA_ALL

Sr.No

參數及說明

imap_stream (Mandatory)

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

mailbox(Mandatory)

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

options (Mandatory)

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

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 - imap_status() Function。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。