首页
/ Django-Mailgun 技术文档

Django-Mailgun 技术文档

2024-12-26 14:39:48作者:凌朦慧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 的批量发送功能,你需要在 EmailMessageextra_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()

请注意,django-mailgun 不会验证你提供的数据是否符合 Mailgun API 的要求,它只是简单地将你提供的值映射到 API。

4. 项目安装方式

请参考上文“安装指南”部分。

以上是关于 django-mailgun 的基本介绍和使用方法。如果你有任何问题或需要进一步的澄清,请随时查阅 Mailgun 的官方文档。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8