1. 相关资料

php-imap 用于获取邮件 ，但是没有详细的官方文档 ，在这里整理一份分享给大家

composer require php-imap/php-imap

2. php-imap 成员

2.1 构造方法

/**
 * @param string $imapPath
 * @param string $login
 * @param string $password
 * @param string $attachmentsDir
 * @param string $serverEncoding
 *
 * @throws InvalidParameterException
 */
public function __construct($imapPath, $login, $password, $attachmentsDir = null, $serverEncoding = 'UTF-8')
{
    $this->imapPath = trim($imapPath);
    $this->imapLogin = trim($login);
    $this->imapPassword = $password;
    $this->setServerEncoding($serverEncoding);
    if (null != $attachmentsDir) {
        $this->setAttachmentsDir($attachmentsDir);
    }
}

2.2 邮件信息相关的成员

2.3 邮件附件相关的成员

2.4 邮箱信息相关的成员

2.5 设置邮件的成员

2.6 连接相关的成员

2.7 其他配置相关的成员

3. IncomingMailHeader

getMailHeader() 方法会返回邮件的 IncomingMailHeader 实例 ，下面看可以从 IncomingMailHeader 中提取到哪些信息

4. 返回值一览

4.1 PhpImap\Mailbox 的 checkMailbox() 的返回值

返回一个 stdClass

stdClass Object
(
    [Date] => Mon, 6 Jan 2020 06:45:48 +0800
    [Driver] => imap
    [Mailbox] => {imap.163.com:143/imap/tls/user="cangsongbayu@163.com"}INBOX
    [Nmsgs] => 2
    [Recent] => 2
)

4.2 PhpImap\Mailbox 的 getMailsInfo(array $mailsIds) 的返回值

返回的数组中每一项都是 stdClass ，包含了对应邮件的一些描述信息

Array
(
    [0] => stdClass Object
        (
            [subject] => test
            [from] => 苍松 拔雨 
            [to] => "cangsongbayu@163.com" 
            [date] => Sun, 5 Jan 2020 22:39:23 +0000
            [message_id] =>    
            [size] => 7364
            [uid] => 1524851185
            [msgno] => 1
            [recent] => 0
            [flagged] => 0
            [answered] => 0
            [deleted] => 0
            [seen] => 0
            [draft] => 0
            [udate] => 1578263965
        )

    [1] => stdClass Object
        (
            [subject] => test subject
            [from] => " 苍松拔雨 " <1228950011@qq.com>
            [to] => " cangsongbayu " 
            [date] => Mon, 6 Jan 2020 06:41:46 +0800
            [message_id] => 
            [size] => 2324
            [uid] => 1524851186
            [msgno] => 2
            [recent] => 0
            [flagged] => 0
            [answered] => 0
            [deleted] => 0
            [seen] => 0
            [draft] => 0
            [udate] => 1578264108
        )

)

4.3 PhpImap\Mailbox 的 getListingFolders($pattern = '*') 的返回值

返回邮箱中列出的文件夹列表

Array
(
    [0] => {imap.163.com:143}INBOX
    [1] => {imap.163.com:143}草稿箱
    [2] => {imap.163.com:143}已发送
    [3] => {imap.163.com:143}已删除
    [4] => {imap.163.com:143}垃圾邮件
    [5] => {imap.163.com:143}病毒文件夹
)

4.4 PhpImap\Mailbox 的 getMailboxes() 的返回值

返回邮箱中所有的文件夹列表

Array
(
    [0] => Array
        (
            [fullpath] => {imap.163.com:143}INBOX
            [attributes] => 0
            [delimiter] => /
            [shortpath] => INBOX
        )

    [1] => Array
        (
            [fullpath] => {imap.163.com:143}草稿箱
            [attributes] => 0
            [delimiter] => /
            [shortpath] => 草稿箱
        )

    [2] => Array
        (
            [fullpath] => {imap.163.com:143}已发送
            [attributes] => 0
            [delimiter] => /
            [shortpath] => 已发送
        )

    [3] => Array
        (
            [fullpath] => {imap.163.com:143}已删除
            [attributes] => 0
            [delimiter] => /
            [shortpath] => 已删除
        )

    [4] => Array
        (
            [fullpath] => {imap.163.com:143}垃圾邮件
            [attributes] => 0
            [delimiter] => /
            [shortpath] => 垃圾邮件
        )

    [5] => Array
        (
            [fullpath] => {imap.163.com:143}病毒文件夹
            [attributes] => 0
            [delimiter] => /
            [shortpath] => 病毒文件夹
        )

)

5. 参数补充说明

5.1 PhpImap\Mailbox 的 setFlag(array $mailsIds, $flag) 参数说明

有错误的地方欢迎指出 ，或者补充也可以 ，感谢每个对我提出建议的人

本作品采用《CC 协议》，转载必须注明作者和本文链接