软件包使用背景:
随着物联网的迅速发展,越来越多的电子设备实现了智能化,从前都是人与人之间的交流,而如今更多的人希望自己的设备也能和自己进行“交流”。而最简单的交流方式,即通过“邮件交流”。SMTP即简单邮件传输协议,我们平时通过邮箱软件发送邮件就是基于这个协议。 本软件包基于嵌入式平台实现了SMTP协议,使设备能够自动给指定的收件人发送邮件。可用于电力监控、智能家居等领域。该软件包不仅支持普通的25端口,还支持465/587这两个加密端口,进一步拓宽使用场景。其使用方法也非常简单,使用者无需关注SMTP的具体实现,当你设置好一些基本参数后,仅需调用一个接口,便可实现邮件的发送!想与你的设备实现“书信往来”吗?那就赶快来试试这个软件包吧!
SMTP_CLIENT的使用
简介
这是一个基于RT-Thread的SMTP软件包,其支持普通的25端口,同时也支持465和587这两个加密端口。该软件包的使用非常简单方便,如果是基于RT-Thread操作系统,则无需进行任何移植操作即可使用,且仅需调用几个简单的接口即可实现不同端口的邮件发送功能。
特性
★支持25端口★支持加密功能,支持465,587端口。(有些邮件服务器可能不支持其中的某个端口,用户使用前需了解自己所选用的邮件服务器支持哪个端口的smtp功能)★使用简单,无需了解SMTP协议,设置好一些必要参数后仅需一个接口即可实现邮件发送。
软件包使用说明
准备工作
Env 配置说明
首先需要下载 SMTP_CLIENT 软件包,并将软件包加入到项目中。在 BSP 目录下使用 menuconfig 命令打开 Env 配置界面,在 RT-Thread online packages → IoT - internet of things
中选择 SMTP_CLIENT 软件包,具体路径如下:
1RT-Thread online packages
2 IoT - internet of things --->
3 [*] smtp_client:smtp client package for rt-thread --->
4 Version (latest) --->
5 [*] use 465/587 port(encrypted port)
6 [ ] enable debug log information
7 smtp_client Options --->
8 [*] smtp client example
◢ Version: 配置软件版本◢ use 465/587 port(encrypted port): 使用加密端口,选中后会将 mbedtls 软件包加入编译,同时开启 465和587 两个加密端口的支持。◢ enable debug log information: 使能调试打印信息◢ smtp client example: 加入示例文件注意:加入示例文件后不能直接下载使用,默认示例中缺少SMTP的个人参数,需要用户补全自己的用户名密码及接收方邮箱等信息!
注意事项
◢ 开启加密功能后会占用比较大的RAM空间,请根据自己使用的硬件平台决定是否选用加密。并且适当调大调用发送功能的线程的堆栈大小。(推荐大于4096)
◢ 有些邮件服务器不支持某个加密端口或者默认关闭,使用者需要确认自己选用的邮件服务器所支持的端口,并且确认已经打开邮件服务器的SMTP功能。
◢ 若用户在使用的过程中出现加密有关的错误,请参照 RT-Thread mbedtls 软件包的说明文档。
使用说明
使用步骤
-
调用
smtp_clinet_init
函数初始化 smtp_client 客户端 -
调用
smtp_set_server_addr
函数设置服务器的地址及端口 -
调用
smtp_set_auth
函数设置服务器认证信息 -
调用
smtp_send_mail
函数发送邮件
API详解
1、初始化SMTP客户端
1void smtp_clinet_init(void);
该函数主要用于初始化 smtp 会话结构。2、设置SMTP服务器地址及端口
1int smtp_set_server_addr(const char *server_addr, uint8_t addr_type, const char *port);
该函数用于设置 smtp 服务器地址及端口,地址类型为域名类型和IP类型,分别对应宏 ADDRESS_TYPE_DOMAIN 与 ADDRESS_TYPE_IP .需要注意的是,由于时间仓促及其需求不是很大,目前仅支持域名连接,但如果有需求,在后续版本中会加入IP连接。当然程序中已预留接口,需求紧的用户可使用接口进行拓展。
3、设置 smtp 服务器认证信息
1int smtp_set_auth(const char *username, const char *password);
该函数用于设置 smtp 服务器的认证信息,需要注意有些服务器需要用 凭据 而非用户登录邮箱时的密码进行认证,用户在连接服务器时需要确认自己所用服务器的认证方式。 4、发送邮件
1int smtp_send_mail(char *from, char *to, char *subject, char *body);
该函数为邮件发送函数,在用户设置好服务器的连接参数后,可以直接调用该函数进行邮件的发送。需要注意的是,发送者邮箱地址必须和登录用户名相同。
宏配置说明
若用户在使用过程中发现默认的配置无法满足自身的使用需求,用户可以进入 smtp_client_private.h 文件对相关宏定义参数进行配置: 一般情况下,用户需要根据自己内容的大小对 SMTP_SEND_DATA_MAX_LEN 进行配置即可。
若在使用过程中有任何问题,请与作者取得联系:email: 1931048074@qq.com同时欢迎大家参与到该软件包的开发与维护中来,共同创建一个更加完善、稳定的软件包。主页:https://github.com/WKJay/SMTP_CLIENT
EN