FastAPI-Mail 项目教程

FastAPI-Mail 项目教程

fastapi-mail Fastapi mail system sending mails(individual, bulk) attachments(individual, bulk) 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-mail

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

FastAPI-Mail 项目的目录结构如下：

FastAPI-Mail
├── app
│   ├── models.py
│   └── send_mail.py
├── templates
│   ├── email
│   │   └── email.html
│   └── landing_page.html
├── .env
├── main.py
├── requirements.txt
└── README.md

目录结构介绍

• app: 包含应用程序的主要文件。

  • models.py: 定义了应用程序中使用的数据模型。
  • send_mail.py: 处理邮件发送的逻辑。

• templates: 存放HTML模板文件。

  • email/email.html: 用于生成邮件内容的HTML模板。
  • landing_page.html: 可能用于应用程序的登录页面或其他页面。

• .env: 项目的配置文件，包含敏感信息如邮件服务器的用户名和密码。

• main.py: 应用程序的入口文件，负责启动FastAPI服务。

• requirements.txt: 列出了项目依赖的Python包。

• README.md: 项目的说明文档，通常包含项目的介绍、安装步骤和使用说明。

2. 项目的启动文件介绍

main.py

main.py 是 FastAPI-Mail 项目的启动文件，负责初始化 FastAPI 应用并启动服务。以下是 main.py 的基本结构：

from fastapi import FastAPI
from app.send_mail import send_email

app = FastAPI()

@app.post("/send-email")
async def send_email_endpoint(email_data: dict):
    await send_email(email_data)
    return {"message": "Email sent successfully"}

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

启动文件介绍

• FastAPI 实例化: app = FastAPI() 创建了一个 FastAPI 应用实例。
• 路由定义: @app.post("/send-email") 定义了一个 POST 请求的路由，用于处理发送邮件的请求。
• 邮件发送逻辑: send_email(email_data) 函数负责实际的邮件发送操作。
• 启动服务: uvicorn.run(app, host="0.0.0.0", port=8000) 使用 Uvicorn 启动 FastAPI 服务。

3. 项目的配置文件介绍

.env

.env 文件用于存储项目的配置信息，特别是敏感信息如邮件服务器的用户名和密码。以下是一个示例 .env 文件的内容：

MAIL_USERNAME=your_email@example.com
MAIL_PASSWORD=your_email_password
MAIL_FROM=your_email@example.com
MAIL_PORT=465
MAIL_SERVER=smtp.example.com
MAIL_STARTTLS=False
MAIL_SSL_TLS=True
USE_CREDENTIALS=True
VALIDATE_CERTS=True

配置文件介绍

• MAIL_USERNAME: 邮件服务器的用户名。
• MAIL_PASSWORD: 邮件服务器的密码。
• MAIL_FROM: 发件人的邮箱地址。
• MAIL_PORT: 邮件服务器的端口号。
• MAIL_SERVER: 邮件服务器的地址。
• MAIL_STARTTLS: 是否启用 STARTTLS。
• MAIL_SSL_TLS: 是否启用 SSL/TLS。
• USE_CREDENTIALS: 是否使用凭证。
• VALIDATE_CERTS: 是否验证证书。

这些配置项在 main.py 或其他相关文件中会被读取并用于配置邮件发送服务。

fastapi-mail Fastapi mail system sending mails(individual, bulk) attachments(individual, bulk) 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-mail