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 = "tutorialspoint.test@gmail.com";
         $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 = "tutorialspoint.test@gmail.com";
         $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

列印頁面