README

PHPMailer - 一个用于PHP的全面功能的邮件创建和传输类

构建状态：

类功能

可能是世界上发送PHP邮件最受欢迎的代码！
被许多开源项目使用：WordPress、Drupal、1CRM、SugarCRM、Yii、Joomla!等等
集成了SMTP支持 - 无需本地邮件服务器即可发送
使用多个To、CC、BCC和Reply-to地址发送邮件
适用于不支持HTML电子邮件的邮件客户端的多部分/替代电子邮件
添加附件，包括内联
支持UTF-8内容以及8bit、base64、二进制和quoted-printable编码
通过SSL和SMTP+STARTTLS传输的LOGIN、PLAIN、CRAM-MD5和XOAUTH2机制的SMTP身份验证
自动验证电子邮件地址
防止头注入攻击
47种语言的错误消息！
DKIM和S/MIME签名支持
兼容PHP 5.5及更高版本
命名空间以防止名称冲突
更多！

你可能为什么需要它

许多PHP开发者在他们的代码中使用电子邮件。唯一支持此功能的PHP函数是mail()函数。然而，它不提供任何利用HTML电子邮件和附件等流行功能的支持。

正确格式化电子邮件非常困难。有无数的重叠RFC，需要严格遵守复杂的格式化和编码规则 - 在线找到的大多数直接使用mail()函数的代码都是错误的！请不要被诱惑自己去做 - 如果你不使用PHPMailer，还有许多其他优秀的库你应该在编写自己的代码之前查看 - 尝试SwiftMailer、Zend/Mail、eZcomponents等。

PHP的mail()函数通常通过本地邮件服务器发送，通常由Linux、BSD和OS X平台上的sendmail二进制文件提供前端，但是Windows通常不包括本地邮件服务器；PHPMailer的集成SMTP实现允许在Windows平台上发送电子邮件而无需本地邮件服务器。

许可证

本软件根据LGPL 2.1许可证分发。请阅读LICENSE以获取有关软件可用性和分发的信息。

安装与加载

PHPMailer可在Packagist（使用语义化版本控制）上找到，并推荐通过Composer进行安装。只需将以下行添加到您的composer.json文件中：

"phpmailer/phpmailer": "~6.0"

或者运行：

composer require phpmailer/phpmailer

请注意，vendor文件夹和vendor/autoload.php脚本是由Composer生成的；它们不是PHPMailer的一部分。

如果您想使用Gmail XOAUTH2身份验证类，您还需要在composer.json中添加对league/oauth2-client包的依赖。

另外，如果您没有使用Composer，可以将PHPMailer文件夹的内容复制到PHP配置中指定的include_path目录之一，并手动加载每个类文件。

<?php
use PHPMailer\PHPMailer\PHPMailer;
use PHPMailer\PHPMailer\Exception;

require 'path/to/PHPMailer/src/Exception.php';
require 'path/to/PHPMailer/src/PHPMailer.php';
require 'path/to/PHPMailer/src/SMTP.php';

如果您没有显式使用SMTP类（您可能没有），则不需要为SMTP类添加use行。

如果您不熟悉git或只想获取tarball，请点击GitHub项目页面右侧的'zip'按钮，但请注意，tarball中不包括文档和示例。

旧版本

PHPMailer 5.2（与PHP 5.0 - 7.0兼容）不再支持功能更新，现在只接收安全更新。您可以在5.2-stable分支中找到5.2的最新版本，5.2的未来版本将带有5.2.x版本号，因此现有的Composer配置应继续工作。如果您使用的是PHP 5.5或更高版本，我们建议您进行必要的更改以切换到6.0版本。

从5.2升级

最大的变化是源文件现在位于src/文件夹中，PHPMailer现在声明了命名空间PHPMailer\PHPMailer。这有几个重要的影响——阅读升级指南获取更多详细信息。

最小安装

虽然手动或使用Composer安装整个包很简单、方便且可靠，但您可能只想在项目中包含必要的文件。至少您需要src/PHPMailer.php。如果您使用SMTP，则需要src/SMTP.php，如果您使用POP-before SMTP，则需要src/POP3.php。如果您不向用户显示错误（可以只使用英文错误），可以跳过language文件夹。如果您使用XOAUTH2，还需要src/OAuth.php以及您希望认证的服务所需的Composer依赖项。实际上，使用Composer要容易得多！

一个简单的示例

<?php
// Import PHPMailer classes into the global namespace
// These must be at the top of your script, not inside a function
use PHPMailer\PHPMailer\PHPMailer;
use PHPMailer\PHPMailer\Exception;

//Load Composer's autoloader
require 'vendor/autoload.php';

$mail = new PHPMailer(true);                              // Passing `true` enables exceptions
try {
    //Server settings
    $mail->SMTPDebug = 2;                                 // Enable verbose debug output
    $mail->isSMTP();                                      // Set mailer to use SMTP
    $mail->Host = 'smtp1.example.com;smtp2.example.com';  // Specify main and backup SMTP servers
    $mail->SMTPAuth = true;                               // Enable SMTP authentication
    $mail->Username = 'user@example.com';                 // SMTP username
    $mail->Password = 'secret';                           // SMTP password
    $mail->SMTPSecure = 'tls';                            // Enable TLS encryption, `ssl` also accepted
    $mail->Port = 587;                                    // TCP port to connect to

    //Recipients
    $mail->setFrom('from@example.com', 'Mailer');
    $mail->addAddress('joe@example.net', 'Joe User');     // Add a recipient
    $mail->addAddress('ellen@example.com');               // Name is optional
    $mail->addReplyTo('info@example.com', 'Information');
    $mail->addCC('cc@example.com');
    $mail->addBCC('bcc@example.com');

    //Attachments
    $mail->addAttachment('/var/tmp/file.tar.gz');         // Add attachments
    $mail->addAttachment('/tmp/image.jpg', 'new.jpg');    // Optional name

    //Content
    $mail->isHTML(true);                                  // Set email format to HTML
    $mail->Subject = 'Here is the subject';
    $mail->Body    = 'This is the HTML message body <b>in bold!</b>';
    $mail->AltBody = 'This is the body in plain text for non-HTML mail clients';

    $mail->send();
    echo 'Message has been sent';
} catch (Exception $e) {
    echo 'Message could not be sent. Mailer Error: ', $mail->ErrorInfo;
}

您可以在examples文件夹中找到更多要玩的内容。

就这些。现在您应该可以使用PHPMailer了！

本地化

PHPMailer默认为英语，但在language文件夹中，您可以找到许多（截至撰写时为47个！）PHPMailer可能遇到的错误消息的翻译。它们的文件名包含翻译的ISO 639-1语言代码，例如fr为法语。要指定语言，您需要告诉PHPMailer使用哪种语言，如下所示：

// To load the French version
$mail->setLanguage('fr', '/optional/path/to/language/directory/');

我们欢迎更正和新语言的支持 - 如果您正在寻找更正的任务，请在测试文件夹中运行 PHPMailerLangTest.php 脚本，它将显示任何缺失的翻译。

文档

请从 GitHub 维基开始阅读。如果您遇到问题，这是您首先应该查看的地方，因为它是更新最频繁的。

如何使用 PHPMailer 处理常见场景的示例可以在 examples 文件夹中找到。如果您正在寻找一个好的起点，我们建议您从 Gmail 示例开始。

请注意，为了减少 PHPMailer 部署的代码大小，如果您通过 Composer 或通过 GitHub 的 zip 文件下载加载 PHPMailer，则不再包含示例，因此您需要克隆 git 仓库或使用上述链接直接获取示例。

完整的生成 API 文档在线可用。

您可以通过在顶级文件夹中运行 phpdoc 来生成完整的 API 级别文档，文档将出现在 docs 文件夹中，尽管您需要安装 PHPDocumentor。您可能会发现单元测试是学习如何进行各种操作（如加密）的好来源。

如果文档没有涵盖您需要的内容，请在 Stack Overflow 上的许多问题中搜索，并在您提出有关“SMTP 错误：无法连接到 SMTP 主机”的问题之前，请阅读故障排除指南。

测试

测试文件夹中有一个 test 文件夹中的 PHPUnit 测试脚本。PHPMailer 使用 PHPUnit 4.8 - 我们本想使用 5.x，但我们需要在 PHP 5.5 上运行。

构建状态：

如果这个测试没有通过，您能做些什么来帮助吗？

安全

请负责任地披露发现的任何漏洞 - 将发现的任何安全问题私下报告给维护者。

PHPMailer 5.2.22（2017年1月9日发布）之前的版本存在本地文件披露漏洞， CVE-2017-5223。如果传递给 msgHTML() 的内容来源于未经筛选的用户输入，则相对路径可以映射到绝对本地文件路径并添加为附件。另外请注意，addAttachment（就像 file_get_contents、passthru、unlink 等）也不应传递用户提供的参数！由 Asiasecurity 的 Yongxiang Li 报告。

PHPMailer 5.2.20（2016年12月28日发布）存在 CVE-2016-10045 的远程代码执行漏洞，由 Dawid Golunski 负责任地报告，并由 Paul Buonopane (@Zenexer) 修复。

PHPMailer 5.2.18版本之前（2016年12月发布）存在漏洞CVE-2016-10033，这是一个关键的远程代码执行漏洞，由Dawid Golunski负责报告。

有关安全问题的更多详细信息，请参阅SECURITY。

贡献

请将错误报告、建议和pull请求提交到GitHub问题跟踪器。

我们特别感兴趣的是修复边缘情况、扩展测试覆盖范围和更新翻译。

如果您在文档中发现了错误，或想添加某些内容，请直接修改wiki - 任何人都可以编辑它。

如果您在迁移到PHPMailer GitHub组织之前克隆了git，您需要使用如下命令从您的克隆更新任何引用旧GitHub位置的远程URL：

git remote set-url upstream https://github.com/PHPMailer/PHPMailer.git

请不要再使用SourceForge或Google Code项目；它们已过时，不再维护。

赞助

PHPMailer的开发时间和资源由Smartmessages.net提供，这是一个功能强大的电子邮件营销系统。

其他贡献也非常受欢迎，无论是啤酒🍺、T恤👕、亚马逊愿望清单抢购，还是冷酷的现金💰。如果您想通过捐赠来对维护者或贡献者表示感谢，请通过贡献者页面通过他们的个人资料页面与他们联系。

变更日志

请参阅changelog。

历史

PHPMailer最初由Brent R. Matzelle于2001年编写，作为一个SourceForge项目。
2004年，Marcus Bointon（SF上的coolbru）和Andy Prevost（codeworxtech）接管了项目。
2010年成为Google Code上的Apache孵化器项目，由Jim Jagielski管理。
Marcus于2008年在GitHub上创建了分支。
2013年，Jim和Marcus决定联合起来，将GitHub作为PHPMailer的官方和规范存储库。
PHPMailer于2013年迁至GitHub上的PHPMailer组织。

从SourceForge迁移后发生了什么变化？

SourceForge和Google Code项目的官方继任者。
测试套件。
与Travis-CI的持续集成。
Composer支持。
公共开发。
额外的语言和语言字符串。
CRAM-MD5身份验证支持。
保留了原始SourceForge项目的作者、提交和分支的完整存储库历史。

izisoft / mailer

维护者

详细信息