websauna.newsletter 1.0a3

安装Python包

使用pip安装此软件包。

设置邮件渲染器

您需要注册一个特定于站点的新闻订阅，该订阅负责渲染新闻邮件HTML负载。在您的Initializer.configure_views中执行此操作。示例

# Configure newsletter renderer
from mysite.views.newsletter import NewsletterRenderer
from websauna.newsletter.interfaces import INewsletterGenerator
registry = self.config.registry
registry.registerAdapter(factory=NewsletterRenderer, required=(IRequest,), provided=INewsletterGenerator)

有关更多信息，请参阅demo.py。

取消订阅链接

在您的渲染器HTML代码中，您可以使用Mailgun退订管理

<p class="details">
  {# For Mailgun #}
  <a href="%mailing_list_unsubscribe_url%">Unsubscribe from TokenMarket newsletter.</a>
</p>

设置秘密

在myapp/conf/development-secrets.ini中添加Mailgun API密钥等。

示例

[mailgun]
# Get from Mailgun
api_key = x

# What is the mailing list we use in the test suite
mailing_list = unit-testing@mailgun.websauna.org

# Outbound domain used for the newslettering
domain = mailgun.websauna.org

# From: email we use to send the newsletter
from = MyApp Newsletter <newsletter-demo@websauna.org>

创建Mailgun邮件列表对象

最简单的方法是通过使用生产配置的ws-shell来完成此操作

ws-shell tokenmarket/conf/production.ini

然后使用%cpaste笔记本shell命令

from websauna.system.core.utils import get_secrets
from websauna.newsletter.mailgun import Mailgun
secrets = get_secrets(request.registry)
list_address = secrets["mailgun.mailing_list"]
mailgun = Mailgun(request.registry)
mailgun.create_list(list_address, "MyApp newsletter")

您会收到回复

{'list': {'access_level': 'readonly',
  'address': 'newsletter@example.com',
  'created_at': 'Wed, 25 Jan 2017 17:08:56 -0000',
  'description': 'TokenMarket newsletter',
  'members_count': 0,
  'name': ''},
 'message': 'Mailing list has been created'}

集成您的网站的订阅

该软件包提供了一个基于Boostrap的迷你订阅表单。它非常适合例如放置在网站页脚中。

只需在模板中做

<h3>Follow</h3>
{% include "newsletter/subscription_form.html" %}

有关更多信息，请运行演示并查看demotemplates/site/footer.html。

发送和预览

访问管理员界面中的新闻标签以预览和发送新闻邮件。

重置新闻收集日期

您可以从shell手动设置新闻状态，例如最后一次发送新闻邮件的时间

import datetime
from websauna.newsletter.state import NewsletterState

state = NewsletterState(request)
state.set_last_send_timestamp(datetime.datetime(2016, 12, 24).replace(tzinfo=datetime.timezone.utc))

状态在Redis中管理。

导出订阅者

在控制台

from websauna.system.core.utils import get_secrets
from websauna.newsletter.mailgun import Mailgun
secrets = get_secrets(request.registry)
list_address = secrets["mailgun.mailing_list"]
mailgun = Mailgun(request.registry)
print(mailgun.list_members(list_address))  # TODO: pagination

导入电子邮件订阅者

请注意，在管理员界面中支持导入网站用户。

示例

subscribers = """
mikko@example.com
pete@example.com
"""

from websauna.system.core.utils import get_secrets
from websauna.newsletter.mailgun import Mailgun
from websauna.newsletter.views import subscribe_email

secrets = get_secrets(request.registry)
list_address = secrets["mailgun.mailing_list"]
mailgun = Mailgun(request.registry)

for s in subscribers.split():
    s = s.strip()
    if s:
        subscribe_email(request, s)

使用Celery手动测试

确保在development.ini中Celery不是贪婪的

websauna.celery_config =
    {
        "broker_url":  "redis://127.0.0.1:6379/15",
        "task_always_eager": False,
    }

启动演示（终端1）

pserve ws://websauna/newsletter/conf/development.ini

启动Celery（终端2）

ws-celery  ws://websauna/newsletter/conf/development.ini -- worker

1.0a3 (2018-10-03)

• 订阅后，将用户重定向回原始URL。

• 支持Python 3.7。

1.0a2 (2018-04-22)

• 修复缺失的“namespace_packages”。

1.0a1 (2018-03-06)

• 初始版本