ESP-Mail-Client 开源项目教程

2024-08-23 07:35:49作者：胡易黎Nicole

The comprehensive Arduino Email Client Library to send and read Email for Arduino devices. The library also supports other network shields or modules e.g., Wi-Fi, Ethernet, and GSM/4G modules.

项目地址：https://gitcode.com/gh_mirrors/es/ESP-Mail-Client

1. 项目的目录结构及介绍

ESP-Mail-Client 项目的目录结构如下：

ESP-Mail-Client/
├── examples/
│   ├── Fetch_Email/
│   ├── Send_Email/
│   └── ...
├── src/
│   ├── ESP_Mail_Client.cpp
│   ├── ESP_Mail_Client.h
│   └── ...
├── library.properties
├── LICENSE
└── README.md

目录结构介绍

examples/: 包含多个示例项目，如 Fetch_Email 和 Send_Email，展示了如何使用 ESP-Mail-Client 库发送和接收邮件。
src/: 包含库的核心源文件，如 ESP_Mail_Client.cpp 和 ESP_Mail_Client.h。
library.properties: 库的属性文件，用于 Arduino IDE 的库管理。
LICENSE: 项目的许可证文件。
README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件主要是 examples/ 目录下的示例代码。以 Send_Email 为例：

#include <Arduino.h>
#include <ESP_Mail_Client.h>

void setup() {
  Serial.begin(115200);
  // 初始化网络和邮件客户端
  // ...
}

void loop() {
  // 发送邮件
  // ...
}

启动文件介绍

#include <Arduino.h>: 引入 Arduino 核心库。
#include <ESP_Mail_Client.h>: 引入 ESP-Mail-Client 库。
setup(): 初始化串口和邮件客户端。
loop(): 循环执行发送邮件的操作。

3. 项目的配置文件介绍

项目的配置文件主要是 examples/ 目录下示例代码中的配置部分。以 Send_Email 为例：

SMTPSession smtp;

void setup() {
  Serial.begin(115200);

  // 配置 SMTP 服务器
  smtp.debug(1);
  smtp.callback(smtpCallback);

  ESP_Mail_Session session;
  session.server.host_name = "smtp.example.com";
  session.server.port = 587;
  session.login.email = "your_email@example.com";
  session.login.password = "your_password";
  session.login.user_domain = "mydomain.com";

  // 创建邮件
  SMTP_Message message;
  message.sender.name = "ESP Mail";
  message.sender.email = "your_email@example.com";
  message.subject = "ESP Mail Test";
  message.addRecipient("Recipient", "recipient_email@example.com");

  String textMsg = "Hello, this is a simple text message from ESP Mail Client.";
  message.text.content = textMsg.c_str();

  // 发送邮件
  if (!smtp.connect(&session))
    return;

  if (!MailClient.sendMail(&smtp, &message))
    Serial.println("Error sending Email, " + smtp.errorReason());
}

配置文件介绍

SMTPSession smtp: 定义 SMTP 会话对象。
smtp.debug(1): 启用调试模式。
smtp.callback(smtpCallback): 设置回调函数。
ESP_Mail_Session session: 定义邮件会话配置。
- session.server.host_name: SMTP 服务器地址。
- session.server.port: SMTP 服务器端口。
- session.login.email: 登录邮箱地址。
- session.login.password: 登录密码。
- session.login.user_domain: 用户域名。
SMTP_Message message: 定义邮件内容。
- message.sender.name: 发件人名称。
- message.sender.email: 发件人邮箱。
- message.subject: 邮件主题。
- message.addRecipient: 添加收件人。
- message.text.content: 邮件