包简介

PHPMailer library

README 文档

README

项目简介

Pigeon Mail 是一个基于 PHPMailer 封装的简单、稳定的邮件发送工具包，旨在帮助开发人员识别和解决与SMTP（简单邮件传输协议）相关的错误。无论是网站、Web应用程序还是后端服务，PigeonMail都能够轻松集成，并提供清晰的SMTP错误信息翻译，使开发人员能够更快速、更准确地定位和解决邮件发送中的问题。

功能特点

多种SMTP错误类型的识别和翻译： PigeonMail能够识别多种SMTP错误，包括连接失败、验证问题、邮件内容拒收等，并提供相应的人类可读翻译。无论是针对腾讯邮箱、网易邮箱还是其他邮件服务提供商，该组件都能够提供详尽的解释。
灵活的邮件问题诊断解决方案：通过简单的调用接口，开发人员可以轻松地将PigeonMail集成到现有的邮件发送逻辑中。该组件包能够帮助开发人员快速定位和解决与邮件发送相关的问题，提高系统的稳定性和可靠性。
覆盖广泛的错误类型和邮件服务提供商： PigeonMail涵盖了多种SMTP错误类型，包括但不限于连接失败、身份验证问题、邮件内容被拒绝等。无论是对于腾讯邮箱、网易邮箱还是其他邮件服务提供商，该组件都能够提供清晰的解释和解决方案。

接入指南

<?php

require __DIR__ . '/vendor/autoload.php';

use Mrzkit\PigeonMail\DefaultMailConfig;
use Mrzkit\PigeonMail\MailProvider;
use Mrzkit\PigeonMail\MailTransfer;
use Mrzkit\PigeonMail\Sender;

$mailTransfer = new MailTransfer();

$config = [
    'transport'       => 'smtp',
    'host'            => 'smtp.gmail.com',
    'port'            => 465,
    'encryption'      => 'ssl', // or tls
    'username'        => 'testemail',
    'password'        => 'password',
    'timeout'         => 30,
    'debug'           => true,
    //
    'mailFromAddress' => 'testemail',
    'mailFromName'    => '杰哥',
    'exceptions'      => true,
    'SMTPAuth'        => true,
    'SMTPKeepAlive'   => true,
    'SMTPAutoTLS'     => false,
];

$params = [
    // 发件人
    'from'          => ['address' => 'testemail', 'name' => ''],
    'replyTo'       => ['address' => 'testemail', 'name' => ''],
    // 收件人
    'recipients'    => [
        ['address' => '', 'name' => '']
    ],
    //
    'customHeaders' => [
        "Message-ID"  => null,
        "In-Reply-To" => null,
        "References"  => null,
    ],
    // 抄送人
    'cc'            => [],
    // 密送人
    'bcc'           => [],
    // 邮件标题
    'subject'       => "Mail Title",
    // 邮件内容
    'body'          => '<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>Mail Content Hello World! ' . date('Y-m-d H:i:s') . '</h1>
</body>
</html>',
];

// 设置邮箱各项信息
$mailTransfer->setFrom($params['from'])
    ->setRecipients($params['recipients'])
    ->setReplyTo($params['replyTo'] ?? $params['from'])
    ->setCC($params['cc'] ?? [])
    ->setBCC($params['bcc'] ?? [])
    ->setSubject($params['subject'])
    ->setBody($params['body'])
    ->setAttachments($params['attachments'] ?? [])
    ->setCustomHeaders($params['customHeaders'] ?? []);

$defaultMailConfig = new DefaultMailConfig($config);

$defaultMailProvider = new MailProvider($defaultMailConfig);

$sender = new Sender($mailTransfer, $defaultMailProvider);

$result = $sender->send();

var_dump($result);

jukit/pigeon-mail 适用场景与选型建议

jukit/pigeon-mail 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 12 次下载、GitHub Stars 达 1，最近一次更新时间为 2024 年 03 月 28 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「mail」「imap」「pigeon」「php-imap」「jukit」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 jukit/pigeon-mail 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 jukit/pigeon-mail 我们能提供哪些服务？

定制开发 / 二次开发

基于 jukit/pigeon-mail 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 jukit/pigeon-mail 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

particlebits/imap 5

PHP class to access an IMAP mailbox. Specifically uses the Laminas library and not the IMAP extension.

unyii2/yii2-imap 4

yii2 extension to read and process mails from IMAP and PHP

convenia/pigeon 32

gricob/imap 1

IMAP client for PHP without php-imap extension dependency

beebmx/kirby-courier 40

Courier offers a convenient and painless solution for creating emails tailored for your Kirby website.

larablocks/pigeon 14

A more flexible email message builder for Laravel 5 including chained methods, reusable message configurations, and message layout and template view management.

jukit/pigeon-mail

包简介

关键字：