php imap 附件,学习猿地-PHP-imap 使用参考

1. 相关资料

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

2. php-imap 成员

2.1 构造方法参数

说明

示例$imapPath

服务地址

{imap.163.com:143}

$login

登录名

email@163.com

$password

登录密码

***

$attachmentsDir

附件存储目录，如果设置了这个参数，邮件中的附件会自动存储到这个目录

$serverEncoding

服务器使用的字符编码

-/**

* @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 邮件信息相关的成员成员

所属类

说明

示例searchMailbox($criteria = 'ALL', $disableServerEncoding = false)

PhpImap\Mailbox

根据 $criteria 获取邮箱中的邮件列表，可用的 $criteria 参数参见 https://www.php.net/imap_search

getMail($mailId, $markAsSeen = true)

PhpImap\Mailbox

根据邮件的 $mailId 获取邮件数据，如果获取了附件并设置了附件的默认存储路径，它会自动将邮件附件保存到该路径，返回 PhpImap\IncomingMail 实例

getMailHeader($mailId)

PhpImap\Mailbox

根据邮件的 $mailId 获取邮件数据，返回 PhpImap\IncomingMailHeader 实例

getMailsInfo(array $mailsIds)

PhpImap\Mailbox

获取一组邮件的信息

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 ) )

$textPlain

PhpImap\IncomingMail

以普通文本格式返回邮件内容

$textHtml

PhpImap\IncomingMail

以 HTML 格式返回邮件内容

embedImageAttachments()

PhpImap\IncomingMail

将 $textHtml 中的图片转为 base64

getRawMail($msgId, $markAsSeen = true)

PhpImap\Mailbox

返回邮件的原始数据信息

getMailMboxFormat($mailId)

PhpImap\Mailbox

以 MBOX 格式返回邮件内容

2.3 邮件附件相关的成员成员

所属类

说明

示例hasAttachments()

PhpImap\IncomingMail

如果邮件中有附件返回 true

getAttachments()

PhpImap\IncomingMail

返回一个数组，数组的每一项都是 PhpImap\IncomingMailAttachment 实例

removeAttachment($id)

PhpImap\IncomingMail

根据附件的 id 删除附件( 不会删除文件 )

setAttachmentsIgnore($attachmentsIgnore)

PhpImap\Mailbox

设置是否获取邮件中的附件

getAttachmentsIgnore()

PhpImap\Mailbox

返回 bool ，true 表示是否自动获取附件

setAttachmentsDir($attachmentsDir)

PhpImap\Mailbox

设置附件的存储路径

getAttachmentsDir()

PhpImap\Mailbox

返回当前设置的附件存储路径

$id