sendypy 5.2.5

依赖

• 它是为Python 3.6+编写的

• 依赖于requests模块

注意

• 版本4.0.5 我们将版本更改为与最近更新的Sendy版本匹配。当Sendy引入需要库更新的更改时，我们将更新版本以匹配Sendy版本。

• 版本0.2 现在要求所有API调用都提供api_key变量。这是从版本4.0.4开始对Sendy功能的要求变更。这是一个可能破坏代码的变更。请升级到sendypy v0.2之前，更新您的代码以确保始终在升级前提供API密钥。

• 版本0.1.3b 在create_campaign API调用中添加了新的“标题”变量。它影响调用中变量的默认排序。如果您从先前的版本升级，请确保您考虑到变量的新排序。此新变量是在Sendy v2.1.2.6中添加的。

安装

PIP

pip install sendypy

基本手动安装

$ python setup.py build
$ sudo python setup.py install

替代安装（手动）

将sendy目录放入您的Python路径中。可以是您的Python安装的site-packages目录，或者将您的$PYTHONPATH环境变量设置为包含impersonate目录的目录。

使用

所有变量和响应值均描述在Sendy API文档

使用很简单

from sendy.api import SendyAPI
api = SendyAPI(
     host='https://your-sendy-install.com/sendy/',
     api_key='YOUR_API_KEY',
)

您还可以提供可选的debug变量（默认为False）。这将在发送请求到您的Sendy安装时将调试信息打印到stdout。

订阅 :

api.subscribe(
    'list_id_here',
    'email@address.com',
    'optional first name',
    optional_field=value,
    ...
)

可选字段

• country：用户的2位国家代码。

• ipaddress：用户的IP地址。

• referrer：用户注册的URL。

• gdpr：如果您以符合GDPR的方式注册欧盟用户。

• hp：包含此“蜜罐”字段以防止垃圾邮件机器人。

• silent：如果true，则Sendy将订阅视为单选确认，无论列表设置如何（默认为false）

取消订阅 :

api.unsubscribe('list_id_here', 'email@address.com')

删除 :

api.delete('list_id_here', 'email@address.com')

订阅状态 :

api.subscription_status('list_id_here', 'email@address.com')

订阅者数量 :

api.subscriber_count('list_id_here')

创建活动 :

api.create_campaign(
    from_name='Your Name',
    from_email='Your Sender Email',
    reply_to='Your Reply-to Email',
    title='Your Email Title',
    subject='Your Email Subject',
    plain_text='Plain Text Email Body',
    html_text='HTML Email Body',
    list_ids='list_id_1,list_id_2,list_id_3',
    brand_id='your brand id',
    query_string='Your query string',
    send_campaign=0, # default's to 0, use 1 to send email right away
    segment_ids='segment_id_1,segment_id_2',
    exclude_list_ids='list_id_1,list_id_2,list_id_3',
    exclude_segments_ids='segment_id_1,segment_id_2',
    track_opens=1, # defaults to 1, set to 0 do disable
    track_clicks=1,
    "query_string"='extra data',
    "schedule_date_time"='June 15, 2021 6:05pm',
    "schedule_timezone"='America/New_York',
)

贡献

我们接受通过hg email提交的补丁，这是Mercurial中包含的patchbomb扩展。

有关更多信息，请参阅我们的贡献文档。

您提交补丁的邮件列表是~netlandish/public-inbox@lists.code.netlandish.com。您也可以在此处查看网络存档

https://lists.code.netlandish.com/~netlandish/public-inbox

要快速设置您的sendypy克隆以提交到邮件列表，只需编辑您的.hg/hgrc文件并添加以下内容

[email]
to = ~netlandish/public-inbox@lists.code.netlandish.com

[patchbomb]
flagtemplate = "sendypy"

[diff]
git = 1

我们在此处提供了更多关于此主题的信息

• 贡献

• 使用Mercurial使用电子邮件

• 邮件列表礼仪

版权 & 保修

所有文档、库和示例代码均为2016年Netlandish Inc.、Peter Sanchez版权所有（<pjs@petersanchez.com>）。库和示例代码根据包含的文件BSD许可证的条款向您提供，该许可证在BSD-LICENSE中。

商业支持

此软件以及许多类似软件都是为了支持Netlandish的许多自己的项目以及我们的客户的项目而构建的。我们很乐意帮助您进行下一个项目，所以请通过给我们发送电子邮件到hello@netlandish.com联系我们。