PHP - imap_search() 函数

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

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

语法

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

参数

序号	参数和描述
1	imap_stream (必需) 这是一个字符串值，表示 IMAP 流，是 imap_open() 函数的返回值。
2	criteria (必需) 这是一个字符串值，表示搜索条件。
3	options (可选) 这是一个字符串值，表示可选值 SE_UID。设置后，返回的数组包含 UID 而不是消息序列。
4	$charset (可选) 这是一个字符串值，表示搜索期间使用的 MIME 字符集。

返回值

如果成功，此函数返回一个包含消息编号/UID 的数组，这些编号/UID 代表匹配的消息；如果失败，则返回布尔值 FALSE。

PHP 版本

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

示例

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

<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>");
         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 = "[email protected]";
         $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 = "[email protected]";
         $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_function_reference.htm

打印页面