PHP - imap_list() 函式

PHP−IMAP 函式幫助您訪問電子郵件帳戶，IMAP 代表 **I**nternet **M**ail **A**ccess **P**rotocol，使用這些函式，您還可以使用 NNTP、POP3 協議和本地郵箱訪問方法。

**imap_list()** 函式接受一個表示 IMAP 流的資源值，兩個表示伺服器規範和郵箱層次結構的字串值作為引數，並讀取指定郵箱的列表。

語法

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

引數

序號	引數及描述
1	imap_stream (必填) 這是一個字串值，表示 IMAP 流，是 imap_open() 函式的返回值。
2	ref (必填) 這是一個字串值，表示伺服器規範。
3	pattern (必填) 這是一個字串值，表示郵箱層次結構搜尋的起始位置。

序號

引數及描述

imap_stream (必填)

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

ref (必填)

這是一個字串值，表示伺服器規範。

pattern (必填)

這是一個字串值，表示郵箱層次結構搜尋的起始位置。

返回值

如果成功，此函式返回一個包含郵箱名稱的陣列；如果失敗，則返回布林值 FALSE。

PHP 版本

此函式首次引入 PHP 版本 4，並在所有後續版本中均有效。

示例

以下示例演示了 **imap_list()** 函式的使用：

<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>");
		 
         //list of mailboxes
         $res = imap_list($imap, $url, "*");
         print_r($res);		 

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

輸出

這將生成以下輸出：

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

示例

以下是此函式的另一個示例：

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $mailbox = imap_open($url, $id, $pwd);
         print("Connection established....");
         print("<br>");

         //Creating a mailbox
         $newmailbox1 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1";
         $newmailbox2 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail2";   
         $res = imap_createmailbox($mailbox, imap_utf7_encode($newmailbox1));
         $res = imap_createmailbox($mailbox, imap_utf7_encode($newmailbox2));		 
		 
         //Retrieving the contents of mail boxes
         $list = imap_list($mailbox, $url, "*");
         foreach ($list as $key => $val) {
            print_r($val);
            print("<br>");
         }	 
      ?>
   </body>
</html>

輸出

這將生成以下輸出：

Connection established....
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail2

php_function_reference.htm

列印頁面