PHP - imap_listsubscribed() 函数

PHP 的 IMAP 函数帮助您访问电子邮件帐户，IMAP 代表 **I**nternet **M**ail **A**ccess **P**rotocol，使用这些函数您还可以使用 NNTP、POP3 协议和本地邮箱访问方法。

imap_listsubscribed() 函数是 imap_lsub() 的别名。它接受一个表示 IMAP 流的资源值，两个表示服务器规范和邮箱层次结构的字符串值作为参数，并检索所有已订阅邮箱的列表。

语法

imap_lsub($imap_stream, $ref, $pattern);

参数

序号	参数和描述
1	imap_stream (必填) 这是一个表示 IMAP 流的字符串值，是 imap_open() 函数的返回值。
2	ref (必填) 这是一个表示服务器规范的字符串值。
3	pattern (必填) 这是一个表示邮箱层次结构搜索起始位置的字符串值。

序号

参数和描述

imap_stream (必填)

这是一个表示 IMAP 流的字符串值，是 imap_open() 函数的返回值。

ref (必填)

这是一个表示服务器规范的字符串值。

pattern (必填)

这是一个表示邮箱层次结构搜索起始位置的字符串值。

返回值

此函数返回一个包含所有已订阅邮箱的数组。

PHP 版本

此函数首次引入于 PHP 4 版本，并在所有后续版本中均有效。

示例

以下示例演示了 imap_listsubscribed() 函数的用法：

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
		 
         //Subscribing to the mailbox
         $res = imap_subscribe($imap, $url);
		 
         //Retrieving the list of subscribed mailboxes
         $list = imap_listsubscribed($imap, $url, "*" );	
         print_r($list);		

         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

输出

这将生成以下输出：

Connection established....
Array ( [0] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX [1] )

示例

以下是此函数的另一个示例：

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
		 
         //Creating a mailbox
         $newmailbox1 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box1";
         $newmailbox2 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box2";
         $newmailbox3 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box3";
         imap_createmailbox($imap, imap_utf7_encode($newmailbox1));
         imap_createmailbox($imap, imap_utf7_encode($newmailbox2));
         imap_createmailbox($imap, imap_utf7_encode($newmailbox3));
         print("Mailboxes Created . . . . "."<br>");
		 		 
         //Subscribing to the mailbox
         $res = imap_subscribe($imap, $newmailbox1);
         $res = imap_subscribe($imap, $newmailbox2);
         $res = imap_subscribe($imap, $newmailbox3);
         print("Subscribed to the created mailboxes . . . . "."<br>");
		   
         //List of subscribed mailboxes
         print("List of subscribed mailboxes . . . . "."<br>");
         $list = imap_listsubscribed($imap, $url, "*" );		 
         foreach($list as $ele){
            print($ele."<br>");
         }
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

输出

这将生成以下输出：

Connection established....
Mailboxes Created . . . .
Subscribed to the created mailboxes . . . .
List of subscribed mailboxes . . . .
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box1
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box2
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box3

php_function_reference.htm

打印页面