Django Mailer 使用与技术文档

1. 安装指南

首先，确保您的Python环境已安装Django版本不低于2.2。接着，您可以使用以下命令通过pip安装django-mailer：

pip install django-mailer

安装后，需要在您的Django项目的settings.py文件中添加django_mailer到INSTALLED_APPS列表中：

INSTALLED_APPS = [
    # 其他应用...
    'django_mailer',
]

此外，如果使用PostgreSQL数据库并希望使用其即时通知功能，还需要在项目的__init__.py中添加以下代码：

import django
django.conf.settings.DATABASES['default']['OPTIONS'] = {
    'options': '-c search_path=public'
}

2. 项目的使用说明

django-mailer是一个用于排队发送电子邮件的Django应用。它通过在数据库中存储待发送的邮件来实现这一功能。使用时，通常在视图函数中调用send_mail方法，如下所示：

from django_mailer import send_mail

def my_view(request):
    send_mail('Subject', 'Body', '[e-mail]', ['[e-mail]'])

邮件会在数据库中排队，然后由运行在后台的Celery任务或其他类似的调度任务发送。

3. 项目API使用文档

以下为django-mailer提供的API使用说明：

• send_mail(subject, message, from_email, recipient_list, **kwargs): 发送邮件至队列。参数包括：

  • subject: 邮件主题。
  • message: 邮件正文。
  • from_email: 发件人地址。
  • recipient_list: 收件人地址列表，应为字符串列表。
  • **kwargs: 其他可选参数。

• send_html_mail(subject, html_message, from_email, recipient_list, **kwargs): 与send_mail类似，但用于发送HTML格式邮件。

• EmailMessage: 用于创建邮件实例，支持更复杂的邮件操作。

4. 项目安装方式

除了通过pip安装外，您还可以从源代码安装：

1. 克隆仓库到本地：

   git clone https://github.com/pinax/django-mailer.git
   

2. 进入项目目录并安装：

   cd django-mailer/
   pip install .
   

3. 接下来的步骤与通过pip安装相同，在settings.py中添加应用，并在__init__.py中配置PostgreSQL选项（如果有需要）。

以上为django-mailer项目的安装、使用和API的基本说明。希望对您有所帮助！