# 发送邮件API接口文档
摘要:
通过SMTP协议发送电子邮件的API接口,支持HTML格式邮件。
接口地址:
https://api.nobb.cc/mailapi/?auth=密钥
请求方式:
GET/POST
返回格式:
JSON
请求示例:
https://api.nobb.cc/mailapi/?auth=密钥&to=收件人邮箱&fromName=发件人名称&subject=邮件主题&html=邮件HTML内容
名称 | 必填 | 类型 | 说明 |
---|---|---|---|
auth | 是 | String | API认证密钥 |
to | 是 | String | 收件人邮箱地址,必须为有效的邮箱格式 |
fromName | 否 | String | 发件人显示名称,默认为配置中的名称 |
subject | 否 | String | 邮件主题,默认为"默认主题" |
html | 否 | String | 邮件HTML内容,默认为空 |
状态码 | 描述 |
---|---|
time | 请求时间,格式为YYYY-MM-DD HH:MM:SS |
status | 发送状态:发送成功/发送失败/异常错误 |
from | 发件人邮箱地址 |
fromName | 发件人名称 |
to | 收件人邮箱地址 |
toName | 收件人显示名称 |
error | 错误信息(仅当发送失败或异常时存在) |
{ "time": "2023-05-20 14:30:22", "status": "发送成功", "from": "noreply@example.com", "fromName": "系统通知", "to": "recipient@example.com", "toName": "发件人名称" }失败返回示例:
{ "time": "2023-05-20 14:31:45", "status": "发送失败", "error": "SMTP Error: Could not connect to SMTP host." }异常返回示例:
{ "time": "2023-05-20 14:32:10", "status": "异常错误", "error": "Invalid address: (setFrom) xxx@example.com" }