phpimapPHP中的IMAP扩大简略入门

不管是 IMAP 还是 POP3 ，与 SMTP 合营后都能非常大略地实现一个邮件客户真个功能。
这篇文章我们就紧张来学习一下 PHP 中的 IMAP 扩展的一些大略内容。

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

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

yum install -y libc-client-devel libc-clientln -s /usr/lib64/libc-client.so /usr/lib/libc-client.aln -s /usr/lib64/libkrb5.so /usr/lib/libkrb5.so

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

接下来，我们考试测验连接一下 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