Django-Anymail 使用指南

Django-Anymail 使用指南

django-anymail Django email backends and webhooks for Amazon SES, Brevo (Sendinblue), MailerSend, Mailgun, Mailjet, Postmark, Postal, Resend, SendGrid, SparkPost and more 项目地址: https://gitcode.com/gh_mirrors/dj/django-anymail

项目概述

Django-Anymail 是一个专为 Django 设计的库，它扩展了默认的邮件发送功能，让你能够无缝集成多种电子邮件服务提供商（ESP），如 Amazon SES, Sendinblue, Mailgun 等。这个项目提供了一个统一的API来发送和接收邮件，支持高级特性，而无需锁定特定的服务商。

目录结构及介绍

Django-Anymail 的仓库具有以下基本的目录结构：

django-anymail/
├── anymail/          # 主要的代码库，包含邮件发送和接收逻辑
│   ├── __init__.py
│   ├── backends.py    # 不同ESP的邮件发送后端实现
│   └── ...            # 其他相关模块
├── docs/             # 文档目录，包含详细使用指南等
│   ├── index.rst      # Sphinx 配置文件
│   └── ...
├── tests/            # 单元测试和集成测试代码
│   └── ...
├── .editorconfig     # 编辑器配置文件
├── .flake8           # PEP8代码风格检查配置
├── git-blame-ignore-revs # Git忽略某些修订版的配置
├── gitignore         # Git忽略文件配置
├── pre-commit-config.yaml # Pre-commit钩子配置
├── readthedocs.yml   # ReadTheDocs构建配置
├── ADDING_ESPS.md    # 添加新ESP的指导文档
├── CHANGELOG.rst     # 变更日志
├── LICENSE           # 许可证文件，采用BSD-3-Clause协议
├── README.rst        # 项目快速入门和概览
├── hatch_build.py    # 构建配置脚本（可能用于发布）
├── pyproject.toml    # 项目元数据和依赖管理
├── requirements-dev.txt # 开发环境所需的Python包列表
└── runtests.py       # 运行测试的脚本

项目的启动文件介绍

在实际的Django项目中，并没有直接所谓的“启动文件”，因为Django应用是基于一系列配置启动的。但是，为了使用Django-Anymail，关键的“启动”配置是在settings.py文件中完成的。你需要修改此文件以添加anymail到INSTALLED_APPS列表，配置对应的ESP设置（比如API密钥和域名），并指定EMAIL_BACKEND为Django-Anymail提供的对应ESP后端。

示例配置片段：

INSTALLED_APPS = [
    # ...
    'anymail',
]

ANYMAIL = {
    "MAILGUN_API_KEY": "<your-Mailgun-key>",
    "MAILGUN_SENDER_DOMAIN": 'mg.example.com',  # 根据使用的ESP替换相应的配置
}

EMAIL_BACKEND = "anymail.backends.mailgun.EmailBackend"
DEFAULT_FROM_EMAIL = "you@example.com"
SERVER_EMAIL = "your-server@example.com"

项目的配置文件介绍

Django-Anymail 的核心配置主要发生在项目的主要 settings.py 文件中，通过 ANYMAIL 字典进行。你可以在这个字典中指定你的ESP相关的所有信息。例如，如果你选择使用Mailgun，就会包含API键、发送者域等。此外，你也需要设置 Django 的标准邮件参数，如 EMAIL_BACKEND 来指定使用Django-Anymail的后端，以及 DEFAULT_FROM_EMAIL 和 SERVER_EMAIL 等。

更进一步的配置，包括ESP特有的选项（如跟踪点击、添加元数据、标签等），也是在 settings.py 中完成的，但这些属于更高级的使用范畴，需要具体参考项目的官方文档来了解每项配置的详细用途。

记住，每个ESP的支持详情可能会有所不同，因此在设置之前务必查阅Django-Anymail的官方文档中的相应ESP章节以获得精确的配置指南。

django-anymail Django email backends and webhooks for Amazon SES, Brevo (Sendinblue), MailerSend, Mailgun, Mailjet, Postmark, Postal, Resend, SendGrid, SparkPost and more 项目地址: https://gitcode.com/gh_mirrors/dj/django-anymail