PHP imap_fetch_overview()用法及代码示例

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

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

用法

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

参数

Sr.No	参数及说明
1	imap_stream (Mandatory) 这是一个表示 IMAP 流的字符串值，返回值imap_open()函数。
2	str (Mandatory) 这是一个字符串值，表示消息编号的序列。您还可以将消息间隔指定为 4:12。
3	options(Optional) 这是一个整数值，表示可选值 FT_UID，如果指定，序列将包含 UID 而不是消息编号。

Sr.No

参数及说明

imap_stream (Mandatory)

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

str (Mandatory)

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

options(Optional)

这是一个整数值，表示可选值 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 = "tutorialspoint.test@gmail.com";
         $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] => tutorialspoint.test@gmail.com 
      [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 = "tutorialspoint.test@gmail.com";
         $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 - imap_fetch_overview() Function。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。