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。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。