PHP - imap_getmailboxes() 函数

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

imap_getmailboxes() 函数接受一个表示 IMAP 流的资源值、两个表示服务器规范和邮箱层次结构的字符串值作为参数，并读取/检索邮箱信息。

语法

imap_getmailboxes($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_getMailboxes() 函数的用法。

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

         //Retrieving the contents of mail boxes
         $list = imap_getmailboxes($mailbox, $url, "*");
         print_r($list);         
      ?>
   </body>
</html>

输出

这将生成以下输出：

Connection established....
Array ( 
   [0] => stdClass Object ( 
      [name] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX [attributes] => 64 [delimiter] => / 
   ) 
)

示例

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

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

         //Retrieving the contents of mail boxes
         $list = imap_getmailboxes($mailbox, $url, "*");

         if (is_array($list)) {
            foreach ($list as $key => $val) {		   
               print("Name: ".imap_utf7_decode($val->name) ."<br>");
               print("Delimiter: " . $val->delimiter . "<br>");
               print("Attributes: ".$val->attributes . "<br />");
               print("<br>");
            }         
         } else {
            print(“List empty”);
         }
      ?>
   </body>
</html>

输出

这将生成以下输出：

Connection established....
Name: {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX
Delimiter: /
Attributes: 64

php_function_reference.htm

打印页面