PHPMailer 开源项目安装与使用指南
PHPMailerThe classic email sending library for PHP项目地址:https://gitcode.com/gh_mirrors/ph/PHPMailer
一、项目的目录结构及介绍
当你通过克隆 https://github.com/PHPMailer/PHPMailer.git
或者使用Composer安装PHPMailer之后,你的项目目录结构看起来大致如此:
PHPMailer/
├── examples/
│ ├── simple.php
│ └── utf8-mime.php
├── language/
│ ├── en.lang.php
│ └── zh_CN.lang.php
├── PHPMailer/
│ ├── Exception.php
│ ├── Mailer.php
│ ├── MIME.php
│ ├── OxideMail/rfc822.php
│ ├── RFCMIMEStreamFilter.php
│ ├── Smtp.php
│ ├── Templating/
│ │ └── SmartyTemplateEngine.php
│ └── TextPreProcessor.php
└── src/
└── ...
examples/
: 此目录包含了PHPMailer示例脚本文件。
-
simple.php:演示如何使用 PHPMailer 发送基本的邮件。
-
utf8-mime.php:这个例子展示了如何处理非ASCII字符集和多语言邮件。
language/
: 这是一个语言文件存储目录,用于存放各种语言包翻译的文件。
-
en.lang.php:英语版的错误消息和帮助信息的文件。
-
zh_CN.lang.php:简体中文的错误信息和帮助信息文件。
PHPMailer/
: 此目录存储主要的 PHPMailer 类库文件。
-
Exception.php:异常处理类,用来抛出异常并捕获错误。
-
Mailer.php:主发送器类,负责构造邮件实体并进行发送操作。
-
MIME.php:管理MIME类型的方法和属性。
-
OxideMail/rfc822.php:包含一些RFC-822标准相关的函数,用于邮件头验证和解析。
-
RFCMIMEStreamFilter.php:提供一些流过滤器方法,用于MIME编码和解码。
-
Smtp.php:SMTP客户端代码,实现连接到远程SMTP服务器和发送邮件的主要逻辑。
-
**Templating/
:** 目录下只有一个Smarty模板引擎实现类
SmartyTemplateEngine.php`,它使得PHPMailer能够支持模板化邮件内容。 -
TextPreProcessor.php`: 预处理器类负责对文本进行格式化和美化,增加HTML标签等操作。
src/
: 该目录用于存放所有扩展PHPMailer核心功能的辅助工具类和其他子组件。
二、项目的启动文件介绍
simple.php
:
simple.php
文件是PHPMailer 最简单的使用案例之一.下面是一个简化的simple.php
脚本,展示了如何创建一个新的邮件实例并发送一封测试邮件:
<?php
require 'vendor/autoload.php';
use PHPMailer\PHPMailer\PHPMailer;
use PHPMailer\PHPMailer\Exception;
$mail = new PHPMailer(true); // Passing true enables exceptions
try {
//Server settings
$mail->isSMTP(); // Set mailer to use SMTP
$mail->Host = 'smtp.example.com'; // Specify main and backup SMTP servers
$mail->SMTPAuth = true; // Enable SMTP authentication
$mail->Username = 'your_username@example.com'; // SMTP username
$mail->Password = 'password'; // SMTP password
$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.';
echo 'Mailer Error: ' . $mail->ErrorInfo;
}
?>
三、项目的配置文件介绍
实际上,PHPMailer 没有传统意义上的配置文件(如XML或YAML),因为它是纯面向对象的库,所有的设置都是通过代码传递给PHPMailer
对象实例的.
但是你可以理解以下的关键设置作为“伪配置文件”。
1.SMTP 设置
-
**$mail->isSMTP():**启用了SMTP协议.
-
**$mail->Host:**SMTP服务器域名或IP地址.
-
**$mail->SMTPAuth:**启用身份认证,用于登录SMTP服务器账户.
-
**$mail->Username:**用于登录SMTP服务器的用户名.
-
**$mail->Password:**密码.
-
**$mail->Port:**TCP端口号,一般是25、465、587.
2.发件人和收件人设置
-
**$mail->setFrom:**指定发件人的电子邮件地址和名称.
-
**$mail->addAddress:**添加收件人列表.
-
**$mail->addReplyTo:**设置回执地址.
-
**$mail->addCC:**添加抄送地址.
-
**$mail->addBCC:**添加密送地址.
3.邮件内容设置
-
**$mail->isHTML:**是否使用HTML格式发送邮件.
-
**$mail->Subject:**邮件主题.
-
**$mail->Body:**邮件正文(可以包含HTML).
-
**$mail->AltBody:**备用文本,当邮件客户端不支持HTML时显示.
最后,PHPMailer具有很多其他高级特性,例如邮件模板渲染、基于事件的回调、错误日志记录等,不过这些都需要更深入地研究其API文档才能灵活掌握.如果你遇到任何问题或疑惑,不妨参考一下PHPMailer GitHub上的示例代码和文档说明.希望这份教程对你有所帮助!
PHPMailerThe classic email sending library for PHP项目地址:https://gitcode.com/gh_mirrors/ph/PHPMailer