PHP imap_search()用法及代码示例

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

这个imap_search()接受表示 IMAP 流的资源值和表示搜索条件的字符串值作为参数，搜索邮箱并以数组的形式返回匹配的消息。

用法

imap_search($imap_stream, $criteria, [$options, $charset]);

参数

Sr.No	参数及说明
1	imap_stream (Mandatory)s 这是一个表示 IMAP 流的字符串值，返回值imap_open()函数。
2	criteria (Mandatory) 这是一个表示搜索条件的字符串值。
3	options (Optional) 这是一个字符串值，表示可选值 SE_UID。在设置时，重新调整的数组包含 UID 而不是消息序列。
4	$charset (Optional) 这是一个字符串值，表示要在搜索期间使用的 MIME 字符集。

返回值

此函数返回一个数组，其中包含表示成功情况下匹配消息的消息编号/UID 和失败情况下的布尔值 FALSE。

PHP版本

这个函数最初是在 PHP 版本 4 中引入的，并且适用于所有后续版本。

示例

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

<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>");
         print("Results of the search:"."<br>");
         
         $emailData = imap_search($imap, '');
         print_r($emailData);
	    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

这会生成以下输出 -

Connection established....
Results of the search:
Array ( [0] => 1 [1] => 2 [2] => 3 [3] => 4 [4] => 5 [5] => 6 )

示例

以下是此函数的另一个示例；这会读取当前收件箱中看不见的消息 -

<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>");
         print("Contents of the matched messages:"."<br>");
         $emailData = imap_search($imap, "UNSEEN");
         foreach ($emailData as $msg) {
            $msg = imap_fetchbody($imap, $msg, "1");
            print(quoted_printable_decode($msg)."<br>");                
         }    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

输出

这将生成以下输出 -

Connection established....
Contents of the matched messages:
Array ( [0] => 4 [1] => 5 [2] => 6 )
#sample_mail4
#sample_mail5
#sample_mail6

示例

以下是带有可选参数的此函数的示例 -

<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>");
         print("Contents  of the matched messages:"."<br>");
         $data = imap_search($imap, "ALL", SE_UID);
         print_r($data);
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

输出

这将生成以下输出 -

Connection established....
Contents of the matched messages:
Array ( 
   [0] => 19 
   [1] => 20 
   [2] => 42 
   [3] => 49 
   [4] => 50 
   [5] => 51 
)

相关用法

注：本文由纯净天空筛选整理自 PHP - imap_search() Function。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。