PHP中的IMAP扩展简单入门

坍缩重载
• 阅读 2387

对于邮件处理来说，大家比较熟悉的应该是 POP3 、 SMTP 这类的协议，而今天我们介绍的 IMAP 其实也是非常常用的一种邮件处理协议。它和 POP3 比较类似，都是以接收处理邮件为主。不过相对于 POP3 来说，IMAP 在本地的操作都会直接同步到线上的邮件服务器， POP3 一般不会直接地进行同步，这就是它们两个最大的区别。关于这些邮件协议的具体内容，如果还有不太了解的同学，可以多在网上查阅相关的资料。

不管是 IMAP 还是 POP3 ，与 SMTP 配合后都能非常简单地实现一个邮件客户端的功能。这篇文章我们就主要来学习一下 PHP 中的 IMAP 扩展的一些简单内容。

安装扩展

首先，就是安装 IMAP 的扩展。这个扩展是随 PHP 源码包一起发布的，在编译的时候可以直接给 configure 添加 --with-imap 以及 --with-imap-ssl 就可以了。如果是后期安装的话，直接在源码包的 ext 目录下找到 imap 目录就可以进去进行普通的扩展安装步骤了。

不过需要注意的是，IMAP 扩展是需要操作系统环境中也安装一些组件的。

yum install -y libc-client-devel libc-client
ln -s /usr/lib64/libc-client.so /usr/lib/libc-client.a
ln -s /usr/lib64/libkrb5.so /usr/lib/libkrb5.so

我们需要安装 libc-client-devel ，然后建立两个软连接。否则在扩展编码安装的时候可能出现问题。

连接 QQ 邮箱

接下来，我们尝试连接一下 QQ 邮箱。

$host = "{imap.qq.com:993/imap2/ssl}INBOX";
$username = "xxxx";   // 不用带 @qq.com
$password = "xxxxxx"; // 开通 imap 后获得的授权登录码

$mbox = imap_open($host, $username, $password);

很简单的函数，imap_open() 用于打开连接邮箱的句柄。三个参数也很直观，host 指定邮箱的域名地址，并且可以直接指定连接到邮箱中的哪个文件夹。在这里我们直接进入的是收件箱。连接 QQ 邮箱的时候用户名直接使用 QQ 号就可以了，不需要在后面带上 @qq.com 。而密码则是我们在 QQ 邮箱的设置中，选择帐号管理，开通 imap 功能后所获得的授权登录码。

查看邮箱信息

连接邮箱成功后，就可以查看相关的一些信息。

$rowsCount = imap_num_msg($mbox);
echo $rowsCount, PHP_EOL;
// 37

imap_num_msg() 返回的是邮箱中的消息数量，其实也就是我们的邮件数量。

$list = imap_list($mbox, "{imap.qq.com}", "*");
var_dump($list);
// array(6) {
//     [0]=>
//     string(18) "{imap.qq.com}INBOX"
//     [1]=>
//     string(26) "{imap.qq.com}Sent Messages"
//     [2]=>
//     string(19) "{imap.qq.com}Drafts"
//     [3]=>
//     string(29) "{imap.qq.com}Deleted Messages"
//     [4]=>
//     string(17) "{imap.qq.com}Junk"
//     [5]=>
//     string(51) "{imap.qq.com}&UXZO1mWHTvZZOQ-/xxxxxx@139.com"
//   }

imap_list() 函数返回的是邮箱中的文件夹信息，比如我们这里有 INBOX 收件箱、Sent Messages 已发送邮件、Drafts 草稿箱、Deleted Messages 已删除邮件、Junk 垃圾箱，另外还有一个是我的邮箱中绑定的 139 的邮箱文件夹也显示了出来。

$chk = (array) imap_mailboxmsginfo($mbox);
var_dump($chk);
// array(8) {
//     ["Unread"]=>
//     int(34)
//     ["Deleted"]=>
//     int(0)
//     ["Nmsgs"]=>
//     int(37)
//     ["Size"]=>
//     int(951128)
//     ["Date"]=>
//     string(37) "Wed, 16 Dec 2020 14:31:50 +0800 (CST)"
//     ["Driver"]=>
//     string(4) "imap"
//     ["Mailbox"]=>
//     string(54) "{imap.qq.com:993/imap/notls/ssl/user="149844827"}INBOX"
//     ["Recent"]=>
//     int(0)
//   }

imap_mailboxmsginfo() 返回的是当前邮箱文件夹中的信息。从返回的字段可以看出，我们有 Unread 未读邮件 34 封。新邮件 37 封，大小、获取时间、邮箱信息等内容。

读取操作邮件

最后就是我们的重头戏了，如何下载读取邮件以及进行一些简单地操作。

$all = imap_search($mbox, "ALL");
var_dump($all);
// array(37) {
//     [0]=>
//     int(1)
//     [1]=>
//     int(2)
//     [2]=>
//     int(3)
//     [3]=>
//     int(4)
//     [4]=>
//     int(5)
// ……
// ……

foreach ($all as $m) {
    $headers = imap_fetchheader($mbox, $m);
    $rawBody = imap_fetchbody($mbox, $m, FT_UID);

    $headers = iconv_mime_decode_headers($headers, 0, "UTF-8");

    var_dump($headers);
    if (isset($headers['Content-Transfer-Encoding']) && $headers['Content-Transfer-Encoding'] == 'base64') {
        $rawBody = imap_base64($rawBody);
    }
    var_dump($rawBody);

    if ($m == 1) {
        imap_mail_copy($mbox, $m, "Drafts"); // 拷贝到草稿箱
        imap_setflag_full($mbox, $m, "Seen"); // 设置为已读
    }

    if ($m == 2) {
        imap_delete($mbox, $m); // 删除
        imap_expunge($mbox);
    }
    if ($m == 3) {
        imap_mail_move($mbox, $m, "Junk"); // 移动
        imap_expunge($mbox);
    }
}

imap_search() 用于查找邮件，它的第二个参数是指定的字符串，比如这个 ALL 就是返回所有的邮件信息，它还可以指定为 DELETED、UNSEEN 等许多内容。具体的参数列表大家可以查阅相关的文档。这个函数获取的是邮件信息的所有的邮件编号，其实可以看出来，它就是从 1 到 37 的数字编号。

读取邮件

imap_fetchheader() 和 imap_fetchbody() 分别就是根据邮件编号读取邮件的头信息和内容信息。如果正常打印的话，它们的内容都是经过编码的，也就是说我们不能直观地看到具体的内容信息。所以需要对头文件进行一个 UTF-8 解码的过程，邮件内容则根据头信息中的 Content-Transfer-Encoding 字段查看对应的编码类型进行解码。这里我们只演示了 base64 编码的情况，其实它还有别的编码格式，有兴趣的同学可以自己查阅资料深入了解一下。

// 第一封邮件
// headers
// array(13) {
//     ["From"]=>
//     string(29) "QQ邮箱团队 <10000@qq.com>"
//     ["To"]=>
//     string(29) "xxx <xxxxxxx@qq.com>"
//     ["Subject"]=>
//     string(53) "更安全、更高效、更强大，尽在QQ邮箱APP"
//     ["Date"]=>
//     string(31) "Wed, 16 Dec 2020 10:08:54 +0800"
//     ["Message-ID"]=>
//     string(38) "<app_popularize.1608084534.3423313103>"
//     ["X-QQ-STYLE"]=>
//     string(1) "1"
//     ["X-QQ-SYSID"]=>
//     string(9) "100000010"
//     ["X-QQ-MIME"]=>
//     string(21) "TCMime 1.0 by Tencent"
//     ["X-QQ-Mailer"]=>
//     string(10) "QQMail 2.x"
//     ["X-QQ-mid"]=>
//     string(30) "mmnez10417t1608084534tfekjqwx0"
//     ["Content-Type"]=>
//     string(26) "text/html; charset="utf-8""
//     ["Content-Transfer-Encoding"]=>
//     string(6) "base64"
//     ["Mime-Version"]=>
//     string(3) "1.0"
//   }

上述内容就是第一封邮件的 header 信息，从信息内容中可以看到 Subject 就是邮件的标题，这是一封 QQ 邮箱系统发出的邮件。From 和 To 分别就是发件人和收件人的邮箱地址。其它比较重要的就是 Content-Type 和 Content-Transfer-Encoding 分别对应着文档类型、字符集编码和转换编码类型。

不同的邮件的邮件头会不一样，我们这里只是展示了最简单的一种。

// rawBody
// string(5850) "
// <!DOCTYPE html>
// <html>
// <head>
//   <meta charset="UTF-8">
//   <title>imap</title>
//   <style>
//     @media screen and (min-width: 700px) {
//       .bottomErweima {
//         display: block !important;
//       }
//       #btn {
//         display: none !important;
//       }
//       .footer {
//         display: none !important;
//       }
//     }
//     /* vivo手机width: 980px 同时 aspect-ratio小于1的,处于700px-1000px的手机*/
//     @media screen and (min-width: 700px) and (max-width: 1000px) and (max-aspect-ratio:1/1){
//       .bottomErweima {
//         display: none !important;
//       }
//       #btn {
//         display: block !important;
//       }
//       .footer {
//         display: block !important;
//       }
//     }
//   </style>
// </head>
// <body style="width: 100%;margin: 0;padding: 0;position: relative;">
//   <div id="email-box" style="max-width: 550px;margin: 0 auto;">
//     <div class="email_container">
//       <div  class="head" style="background: #f3f3f3;">
//         <span class="content" style="font-size: 14px;color: #000000;line-height: 26px;display: block;padding: 40px 20px;">QQ邮箱APP，让高效触手可及。在这里，你可以登录多个邮箱账号、便捷存储微信邮件、多窗口编辑邮件......还有更多功能，等你探索！</span>
//       </div>
// ……
// ……

邮件的内容在使用 imap_base64() 解析之后就是简单地 HTML 格式的内容。这和头信息中的 Content-Type 是直接对应的。imap_base64() 其实和 base64_decode() 并没有什么区别，大家直接使用 base64_decode() 也是没有问题的。当然，前提是要判断 Content-Transfer-Encoding 中是否使用了 base64 来对邮件内容进行了编码。有的邮件中可能连这个字段都没有。

复制、移动、删除邮件

imap_mail_copy() 用于复制邮件，在这里，我们将第一封邮件复制到了草稿箱中，然后使用 imap_setflag_full() 将这封邮件标记为已读。从参数就可以看出来 Seem 就是已读的意思，当然它还有别的参数，比如 Deleted 、 Draft 之类的内容。

imap_delete() 函数用于删除邮件，imap_mail_move() 用于移动文件，调用这两个函数都需要使用 imap_expunge() 来将操作同步到线上。

进行完操作后，大家可以直接看一下线上的邮件是不是已经产生了相应的变化了。

总结

IMAP 的知识我们就简单地入门学习一下，因为在学习这块内容的时候我发现网上已经有很多大神门封装好的类可以让我们直接复制下来使用。另外，它的功能非常丰富，还有很多函数并没有介绍，比如说操作附件之类的功能，相信大家在自己的学习和使用过程中都会慢慢接触到的。

测试代码：

https://github.com/zhangyue0503/dev-blog/blob/master/php/202012/source/6.PHP中的IMAP扩展简单入门.php

参考文档：

https://www.php.net/manual/zh/book.imap.php

各自媒体平台均可搜索【硬核项目经理】

php
点赞
收藏
评论区
推荐文章
Karen110 Karen110
•
3年前
手把手教你使用Python轻松搞定发邮件
前言现在生活节奏加快，人们之间交流方式也有了天差地别，为了更加便捷的交流沟通，电子邮件产生了，众所周知，电子邮件其实就是客户端和服务器端发送接受数据一样，他有一个发信和一个收信的功能，电子邮件的通信协议为SMTP，POP3,IMAP，而且他们都属于tcp/ip协议，像我们经常用到的QQ邮箱，网易邮箱，这些都是同样的模式。准备编辑器：sublime
1855
0
0
Easter79 Easter79
•
3年前
SpringBoot使用JavaMailSender发送邮件（1）
邮件发送是一个非常常见的功能，最初Sun公司提供了JavaMail用来实现邮件发送，但是配置烦琐。后来Spring中提供了JavaMailsender用来简化邮件配置，而SpringBoot则提供了MailSenderAutoConfiguration对邮件的发送做了进一步简化。在开始之前我们需要申请开通POP3/SMTP服
903
0
0
Stella981 Stella981
•
3年前
LNMP架构介绍 MySQL安装 PHP安装 Nginx介绍
LNMP架构介绍LNMP的简介：LNMP代表的就是：Linux系统下NginxMySQLPHP这种网站服务器架构。Nginx是一个高性能的HTTP和反向代理服务器，也是一个IMAP/POP3/SMTP代理服务器。Mysql是一个小型关系型数据库管理系统。PHP是一种在服务器端执行的嵌
813
0
0
Stella981 Stella981
•
3年前
SpringBoot使用JavaMailSender发送邮件（1）
邮件发送是一个非常常见的功能，最初Sun公司提供了JavaMail用来实现邮件发送，但是配置烦琐。后来Spring中提供了JavaMailsender用来简化邮件配置，而SpringBoot则提供了MailSenderAutoConfiguration对邮件的发送做了进一步简化。在开始之前我们需要申请开通POP3/SMTP服
880
0
0
可莉 可莉
•
3年前
12.6 Nginx安装 12.7 默认虚拟主机 12.8 Nginx用户认证 12.9 Nginx域名重定向
12.5Nginx介绍Nginx("enginex")是一款轻量级的Web服务器/反向代理服务器及电子邮件(IMAP/POP3)代理服务器，并在一个BSDlike协议下发行。其特点是占有内存少，并发能力强，事实上nginx的并发能力确实在同类型的网页服务器中表现较好，中国大陆使用nginx网站用户有:百度、新浪、网
840
0
0
Stella981 Stella981
•
3年前
Linuxprobe15
电子邮件系统简单邮件传输协议（SimpleMailTransferProtocol，SMTP）：用于发送和中转发出的电子邮件，占用服务器的25/TCP端口。邮局协议版本3（PostOfficeProtocol3）：用于将电子邮件存储到本地主机，占用服务器的110/TCP端口。Internet消息访问协议版本4（In
848
0
0
Stella981 Stella981
•
3年前
RabbitMQ详解（二）
RabbitMQ详解（二）消息通信的概念消息通信,有很多种,邮箱qq微信短信等,这些通信方式都有发送者,接受者,还有一个中间存储离线消息的容器.但是这些通信方式和RabbitMQ的通信模型是不一样的,比如邮件,邮件服务器基于_POP3/SMTP_协议,通信双方需要明确指定,并
743
0
0
Wesley13 Wesley13
•
3年前
.net 获取邮箱邮件列表和内容
　　需求：　　最近项目里遇到了个问题，对方没有提供直接获取数据源的api接口，而是通过邮件发数据的。这就需要接收邮件后解析邮件内容获得数据。　　分析：　　想在代码里实时获取邮件，可以通过邮件的几个协议来实现，常用的几个协议有POP3协议，SMTP协议，IAMP协议。　　1.pop3:(PostOfficeProtocal3),3是版本
782
0
0
Stella981 Stella981
•
3年前
Nginx安全加固配置手册
第1章   概述1.1   目标Nginx（发音同enginex）是一款轻量级的Web服务器/反向代理服务器及电子邮件（IMAP/POP3）代理服务器，由俄罗斯的程序设计师IgorSysoev所开发，可以稳定地运行在Linux、Windows等操作系统上，其特点是占用内存少，并发能力强。同其他软件一样，Ng
839
0
0
胖大海 胖大海
•
2年前
什么是nginx
Nginx的介绍Nginx是一款是由俄罗斯的程序设计师IgorSysoev所开发高性能的Web和反向代理服务器，也是一个IMAP/POP3/SMTP代理服务器。在高连接并发的情况下，Nginx是Apache服务器不错
618
0
0
阮小五 阮小五
•
11个月前
Nginx入门学习笔记
Nginx是一款面向性能设计的HTTP服务器，能反向代理HTTP，HTTPS和邮件相关(SMTP，POP3，IMAP)的协议链接。并且提供了负载均衡以及HTTP缓存。它的设计充分使用异步事件模型，削减上下文调度的开销，提高服务器并发能力。采用了模块化设计，
478
0
0
坍缩重载
坍缩重载
Lv1
我绕得过江山错落，绕不过你。
文章
6
粉丝
0
获赞
0
热门文章
WGCLOUD磁盘监测 - v3.5.2支持采集磁盘IO的读写速率了
mysql主从复制总结
自动备份数据库到百度云
拷贝集合
阿里云云原生弹性方案：用弹性解决集群资源利用率难题