PHP imap_listsubscribed()用法及代碼示例

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

這個imap_listsubscribed()函數是一個別名imap_lsub().它接受一個表示 IMAP 流的資源值、兩個表示服務器規範和郵箱層次結構的字符串值作為參數，並檢索所有訂閱郵箱的列表。

用法

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

參數

Sr.No	參數及說明
1	imap_stream (Mandatory) 這是一個表示 IMAP 流的字符串值，返回值imap_open()函數。
2	ref (Mandatory) 這是一個表示服務器規範的字符串值。
3	pattern (Mandatory) 這是一個字符串值，表示郵箱層次結構搜索的開始。

Sr.No

參數及說明

imap_stream (Mandatory)

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

ref (Mandatory)

這是一個表示服務器規範的字符串值。

pattern (Mandatory)

這是一個字符串值，表示郵箱層次結構搜索的開始。

返回值

此函數返回一個包含所有訂閱郵箱的數組。

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