PHP中的IMAP擴展簡單入門

對於郵件處理來說，大家比較熟悉的應該是 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-/[email protected]"
//   }

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郵箱團隊 <[email protected]>"
//     ["To"]=>
//     string(29) "xxx <[email protected]>"
//     ["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中的IMAP擴展簡單入門

安裝擴展

連接 QQ 郵箱

查看郵箱信息

讀取操作郵件

讀取郵件

複製、移動、刪除郵件

總結

學習PHP中統計擴展函數的使用

數學相關函數在PHP中的應用簡介

PHP中操作任意精度大小的GMP擴展學習

學習PHP中的任意精度擴展函數

PHP中的IMAP擴展簡單入門

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結