Django-Mailgun 技术文档

2024-12-26 05:55:00作者：凌朦慧Richard

1. 安装指南

首先，确保你已经安装了 Django。接下来，你可以使用 pip 命令安装 django-mailgun。

pip install django-mailgun

在安装完 django-mailgun 后，你需要在项目的 settings.py 文件中配置一些参数。

EMAIL_BACKEND = 'django_mailgun.MailgunBackend'
MAILGUN_ACCESS_KEY = 'ACCESS-KEY'
MAILGUN_SERVER_NAME = 'SERVER-NAME'

将 ACCESS-KEY 替换为你的 Mailgun 账户详情中的 "API-KEY"，将 SERVER-NAME 替换为你的 "API Base URL" 的最后一部分（例如：https://api.mailgun.net/v3/<your_server_name>）。

2. 项目使用说明

在配置好 django-mailgun 后，你可以像平时一样使用 django.core.mail.send_mail 方法发送邮件，django-mailgun 会自动将邮件发送到 Mailgun。

from django.core.mail import send_mail

send_mail('Subject here', 'Here is the message.', 'from@example.com', ['to@example.com'], fail_silently=False)

3. 项目API使用文档

django-mailgun 支持一些额外的特性，例如：

发送用户特定数据

如果你想利用 Mailgun 的批量发送功能，你需要在 EmailMessage 的 extra_headers 属性中添加一个有效的 JSON 字符串。

from django.core.mail import EmailMessage

email = EmailMessage('Hi!', 'Cool message for %recipient.first_name%', 'admin@example.com', ['joe@example.com', 'jane@example.com'])
email.extra_headers['recipient_variables'] = '{"joe@example.com":{"first_name":"Joe"}, "jane@example.com":{"first_name":"Jane"}}'
email.send()

分析和其他追踪功能

Mailgun 允许你追踪关于你的电子邮件的某些事件。你可以在 API 调用中传递这些选项（更多信息请查看 Mailgun 文档）。如果你在 extra_headers 中添加任何 SMTP 选项，django-mailgun 会将这些值映射到相应的 API 参数。

from django.core.mail import EmailMessage

email = EmailMessage('Hi!', 'Cool message for Joe', 'admin@example.com', ['joe@example.com'])
email.extra_headers['X-Mailgun-Tag'] = ['Tag 1', 'Tag 2']
email.send()

附加数据到消息

你也可以通过 X-Mailgun-Variables 头向邮件附加自定义数据。数据应该格式化为 JSON，并将包含在任何与该电子邮件相关的 webhook 事件中。

from django.core.mail import EmailMessage

email = EmailMessage('Hi!', 'Cool message for Joe', 'admin@example.com', ['joe@example.com'])
email.extra_headers['X-Mailgun-Variables'] = {'my-id': 'email_id', 'my-variable':'variable'}
email.send()