PHP imap_list()用法及代码示例

PHP-IMAP 函数可帮助您访问电子邮件帐户，IMAP 代表I互联网M艾尔A访问权限Protocol 使用这些函数您还可以使用 NNTP、POP3 协议和本地邮箱访问方法。

这个imap_list()函数接受表示 IMAP 流的资源值、表示服务器规范和邮箱层次结构的两个字符串值作为参数，并读取指定邮箱的列表。

用法

imap_list($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)

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

返回值

此函数在成功时返回一个包含邮箱名称的数组，在失败时返回一个布尔值 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 - imap_list() Function。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。