django-mailviews 0.6.5

简介

在Django中渲染和发送电子邮件可能会变得重复且容易出错。通过在视图类中封装消息渲染，您可以轻松地以结构化和清晰的方式编写消息。

基本用法

from mailviews.messages import EmailMessageView

# Subclass the `EmailMessageView`, adding the templates you want to render.
class WelcomeMessageView(EmailMessageView):
    subject_template_name = 'emails/welcome/subject.txt'
    body_template_name = 'emails/welcome/body.txt'

# Instantiate and send a message.
message = WelcomeMessageView().send(extra_context={
    'user': user,
}, to=(user.email,))

这并不是发送消息给用户的最优模式 - 有关更好的方法，请参阅“最佳实践”下的注释。

使用预览站点

from mailviews.previews import autodiscover, site

autodiscover()

urlpatterns = patterns('',
    url(regex=r'^emails/', view=site.urls),
)

from mailviews.previews import Preview, site
from example.emails.views import WelcomeMessageView

# Define a new preview class.
class BasicPreview(Preview):
    message_view = WelcomeMessageView

# Register the preview class with the preview index.
site.register(BasicPreview)

最佳实践

• 在发送电子邮件时，尽量少使用 extra_context 参数。相反，创建一个接受所有生成上下文和发送消息所需对象的 EmailMessageView 子类。例如，"基本用法" 中显示的代码可以改写为以下内容

from mailviews.messages import EmailMessageView

class WelcomeMessageView(EmailMessageView):
    subject_template_name = 'emails/welcome/subject.txt'
    body_template_name = 'emails/welcome/body.txt'

    def __init__(self, user, *args, **kwargs):
        super(WelcomeMessageView, self).__init__(*args, **kwargs)
        self.user = user

    def get_context_data(self, **kwargs):
        context = super(WelcomeMessageView, self).get_context_data(**kwargs)
        context['user'] = self.user
        return context

    def render_to_message(self, *args, **kwargs):
        assert 'to' not in kwargs  # this should only be sent to the user
        kwargs['to'] = (self.user.email,)
        return super(WelcomeMessageView, self).render_to_message(*args, **kwargs)

# Instantiate and send a message.
WelcomeMessageView(user).send()

实际上，您可能发现将上述“用户消息”模式封装到一个 mixin 或子类中很有帮助，该 mixin 或子类为所有与用户相关的电子邮件提供标准抽象。（这留作读者练习。）

测试和开发

已在 Python 2.6、2.7 和 3.4（如果 Django 支持）以及 Django 版本 1.3 至 1.8 上进行测试。（有关支持的具体版本，请参阅 Travis 或 Tox 构建矩阵。）要本地运行针对整个构建矩阵的测试，请运行 make test-matrix（或已安装的 tox）。

make develop

python -m mailviews.tests

python -m mailviews.tests.manage runserver

coverage run --source=. -m mailviews.tests