PHP - imap_fetch_overview() 函数

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

**imap_fetch_overview()** 函数接受表示 IMAP 流的资源值，表示邮箱中消息的字符串值作为参数，并返回指定方法的标题信息的概述。

语法

imap_fetch_overview($imap_stream, $str [, $options]);

参数

序号	参数及描述
1	imap_stream（必填）这是一个表示 IMAP 流的字符串值，是 imap_open() 函数的返回值。
2	str（必填）这是一个表示消息编号序列的字符串值。您还可以指定消息的间隔，例如 4:12。
3	options（可选）这是一个表示可选值 FT_UID 的整数值，如果指定，则序列将包含 UID 而不是消息编号。

序号

参数及描述

imap_stream（必填）

这是一个表示 IMAP 流的字符串值，是 **imap_open()** 函数的返回值。

str（必填）

这是一个表示消息编号序列的字符串值。您还可以指定消息的间隔，例如 4:12。

options（可选）

这是一个表示可选值 FT_UID 的整数值，如果指定，则序列将包含 UID 而不是消息编号。

返回值

此函数返回一个对象数组，每个对象都包含有关各个标题的信息。

PHP 版本

此函数首次引入于 PHP 版本 4，并在所有后续版本中均有效。

示例

以下示例演示了 **imap_fetch_overview()** 函数的使用：

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
		 
         //Fetching the contents of a message
         print("Overview of the first message: "."<br>");
         $overview = imap_fetch_overview($imap, 1);
         print_r($overview);
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

输出

这将生成以下输出：

Connection established....
Overview of the first message:
Array ( 
   [0] => stdClass Object ( 
      [from] => Tutorialspoint [to] => [email protected] 
      [date] => Thu, 22 Oct 2020 20:10:17 +0530 [message_id] => 
      [size] => 4857 [uid] => 19 [msgno] => 1 [recent] => 0 
      [flagged] => 0 [answered] => 0 [deleted] => 0 
      [seen] => 1 [draft] => 0 [udate] => 1603377656 
   ) 
)

示例

以下是使用可选参数的上述函数的示例：

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
		 
         //Fetching the contents of a message
         print("Overview of the first message: "."<br>");
         $MC = imap_check($imap);
         $overview = imap_fetch_overview($imap, "1:{$MC->Nmsgs}");
         
         //print_r($overview);
         foreach ($overview as $obj) {
            print($obj->date);
            print("<br>");
            print($obj->size);
            print("<br>");
            print($obj->uid);	
            print("<br>");
         }    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

输出

这将生成以下输出：

Connection established....
Overview of the first message:
Thu, 22 Oct 2020 20:10:17 +0530
4857
19
Thu, 22 Oct 2020 20:10:52 +0530
4858
20
Sun, 25 Oct 2020 16:11:22 +0530
4880
42
Sun, 25 Oct 2020 17:22:41 +0530
4882
49
Sun, 25 Oct 2020 17:23:10 +0530
4884
50
Sun, 25 Oct 2020 17:24:25 +0530
4883
51

php_function_reference.htm

打印页面