SMTP服务API

发送电子邮件

要发送电子邮件,请发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/emails

请求参数:

参数 类型 描述
电子邮件 对象 带有电子邮件数据的序列化对象 要求

邮件数组参数:

参数 类型 描述
超文本标记语言 字符串 HTML版本的电子邮件,以Base64编码 要求*
文本 字符串 电子邮件的文本版本 要求*
模板 数组 模板: 要求*
id 字符串或整数 在服务中上传的模板ID。使用“在一个Acoount上获得模板列表方法来获取模板IDreal_idid参数) 要求
变量 对象 包含变量的名称和值,格式如下:{“name_of_the_variable”:“value_of_the_variable”}

要求

auto_plain_text 布尔 类型参数,是否为未给定文本的消息自动生成文本部分;默认是 要求
主题 字符串 邮件主题 要求
对象 包含发件人姓名和电子邮件地址的数组 要求
数组 接收者的数组 要求
сс 数组 将接收电子邮件副本的收件人数组。收件人将看到谁收到了电子邮件副本 可选
bcc 数组 一组收件人,他们将收到电子邮件的盲副本。收件人将看不到谁收到了电子邮件副本 可选
附件 对象 数组,其中键是文件的名称,值是文件的内容,例如{“name_of_the_file”:“contents_of_the_file”} 可选
attachments_binary 对象 数组,其中键是文件的名称,值是文件的内容,以Base64编码 可选

*注意:您可以使用参数超文本标记语言而且文本在此请求中直接发送模板。

或者你可以使用参数模板并发送一个静态模板上传到电子邮件服务,只发送这些变量的值(这是添加在模板)。

发送自定义模板的示例:

{"email": {"html": "PHA+RXhhbXBsZSB0ZXh0PC9wPg==", "text": "文本示例","subject": "主题示例","from": {"name": "示例名称","email": "sender@example.com"}, "to": [{"name": "Recipient1名称","email": "recipient1@example.com"}]}}

发送带有自定义变量的系统模板的示例:

{"电子邮件":{“主题”:“测试”、“模板”:{" id ": 123456年,“变量”:{“名称”:“乔治”,“代码”:" 123456 "}},“从”:{“名称”:“迈克”,“电子邮件”:“mike.johnson@domain.com”},”到“:[{“电子邮件”:“recipient1@example.com”,“名字”:“乔治”}]}}

在这个例子中,a模板参数代替超文本标记语言而且文本参数。

发送电子邮件副本示例:

{"电子邮件":{“html”:“dGVzdCBBUEk =”,“文本”:“文本”、“主题”:“主题”,“从”:{“名称”:“测试”、“电子邮件”:“test@test.com”},”到“:[{“名称”:“收件人1”,“电子邮件”:“recipient1@test.com”}],“cc”:[{“名称”:“收件人2”,“电子邮件”:“recipient2@test.com”}],“bcc”:[{“名称”:“收件人3”,“电子邮件”:“recipient3@test.com”}]}}

如果请求成功,您将收到回复:

{"result": true, "id": "pzkic9- 0afesp -fc"}

获取电子邮件列表

要获得所有已发送电子邮件的列表,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/emails

请求参数:

参数 类型 描述
限制 int 记录数量 可选
抵消 int 偏移量(要显示的第一条记录) 可选
字符串 开始日期 可选
字符串 结束日期 可选
发送方 字符串 发送方 可选
收件人 字符串 收件人 可选
国家 字符串 ,国家将不指定 可选

如果请求成功,您将收到回复:

{"id":"pzkic9- 0afesp -fc", "sender":"JohnDoe@test.com", "total_size":1128, "sender_ip":"127.0.0.1", "smtp_answer_code":250, "smtp_answer_subcode":"0", "smtp_answer_data":"Bad receivers ", "used_ip":"5.104.224.87", " receiver ":null, "subject"开云体育手机网页版登录入口官网:"SendPulse::电子邮件确认”、“send_date”:“2013-12-17 10:33:53”、“跟踪”:{“点击”:1、“开放”:1、“链接”:[{“url”:“http://some-url.com”、“浏览器”:“Chrome 29.0.1547.57”、“操作系统”:“Linux”,“screen_resolution”:“1920 x1080”、“知识产权”:“46.149.83.86”,“国家”:“美国”,“action_date”:“2013-09-30”11:27:40}],“client_info”:[{“浏览器”:“雷鸟17.0.8”、“操作系统”:“Linux”,“知识产权”:“46.149.83.86”,“国家”:“美国”,“action_date”:“2013-09-30”11:27:49}]}}

获取发送邮件的总数

要获得发送电子邮件的总数,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/emails/total

如果请求成功,您将收到回复:

{"total": 25408}

获取关于特定电子邮件的信息

要获得关于特定电子邮件的信息,请发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/emails/ {id}

请求参数:

参数 类型 描述
id int 邮箱地址ID 要求

如果请求成功,您将收到回复:

{" id ":“pzkic9-0afezp-fc”、“发件人”:“JohnDoe@test.com”、“total_size”:“1128”,“sender_ip”:“127.0.0.1”、“smtp_answer_code”:“250”,“smtp_answer_subcode”:“0”,“smtp_answer_data”:“坏接受者”,“used_ip”:“5.104.224.87”、“接收方”:空,“主题”:“SendPulse::开云体育手机网页版登录入口官网电子邮件确认”、“send_date”:“2013-12-17 10:33:53”、“跟踪”:{“点击”:1、“开放”:1、“链接”:[{“url”:“http://some-url.com”、“浏览器”:“Chrome 29.0.1547.57”、“操作系统”:“Linux”,“screen_resolution”:“1920 x1080”、“知识产权”:“46.149.83.86”,“国家”:“乌克兰”、“action_date”:“2013-09-30”11:27:40}],“client_info”:[{“浏览器”:“雷鸟17.0.8”、“操作系统”:“Linux”,“知识产权”:“46.149.83.86”,“国家”:“美国”,“action_date”:“2013-09-30”11:27:49}]}}

获取电子邮件列表的信息

为了获得电子邮件列表的信息,发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/emails/info

请求参数:

参数 类型 描述
电子邮件 数组 消息ID列表,每个请求最多500个。例子:[" qj7rpf-0q8ru6-ou”、“qj7rmw-0alndz-r6”、“qj7rgo-0ejrg3-d2”) 要求

获取24小时内有关反弹的信息

若要获取24小时内的反弹信息,请将get请求发送到

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/bounces/day

请求参数:

参数 T特点 描述
日期 字符串 你想要获取信息的日子。格式:YYYY-MM-DD 可选
限制 int 记录数量 可选
抵消 int 偏移量(要显示的第一条记录) 可选

URL示例,从20开始获取10条记录:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/bounces/day?limit=10&offset=20

从此时刻开始,您只能获取最近24小时内的反弹信息。例如,今天是- 2016-04-28 14:34:00,您将获得有关在2016-04-27 14:34:00和2016-04-28 14:34:00之间发生的反弹的信息。

如果请求成功,您将收到回复:

{"id": "pzkic9-0afezp-fc", "sender": "JohnDoe@test.com", "total_size": 1128, "sender_ip": "127.0.0.1", "smtp_answer_code": " 250 ", "smtp_answer_subcode": "0", "smtp_answer_data": "不良收件人","used_ip": "5.104.224.87", "收件人":null ", "subject": "SendPulse::电开云体育手机网页版登录入口官网子邮件确认","send_date": "2013-12-17 10:33:53", "tracking": {"click": 1, "open": 1, "link": [{"url": "http://some-url.com", "browser": "Chrome 29.0.1547.57", "os": "Linux", "screen_resolution": "1920x1080", "ip":“46.149.83.86”、“国家”:“英国”、“action_date”:“2013-09-30 11:27:40”}],“client_info”:[{“浏览器”:“雷鸟17.0.8”、“操作系统”:“Linux”,“知识产权”:“46.149.83.86”,“国家”:“英国”、“action_date”:“2013-09-30”11:27:49}]}}

获得总反弹数

要获得反弹的总数,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/bounces/day/total

如果请求成功,您将收到回复:

{"total": 3}

取消订阅收件人

要取消订阅收件人,发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/unsubscribe

请求参数:

参数 类型 描述
电子邮件 数组 序列化的电子邮件阵列 要求

的例子电子邮件结构:

[{"email": "badUser1@mailserver.com", "comment": "comment1"}, {"email": "badUser2@mailserver.com", "comment": "comment2"}]

如果请求成功,您将收到回复:

{"result": true}

从未订阅列表中删除电子邮件

要从未订阅列表中删除电子邮件,向以下地址发送DELETE请求:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/unsubscribe

请求参数:

参数 类型 描述
电子邮件 数组 例如,一个序列化的电子邮件数组,(“badUser1@mailserver.com”、“badUser2@mailserver.com”) 要求

如果请求成功,您将收到一个响应:

{"result": true}

获取未订阅用户列表

要获得未订阅用户的列表,发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/unsubscribe

请求参数:

参数 类型 描述
日期 字符串 你想了解的日子。格式:YYYY-MM-DD 可选
限制 int 记录数量 可选
抵消 int 偏移量(要显示的第一条记录) 可选

URL示例,从20开始获取10条记录:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/unsubscribe?limit=10&offset=20

如果输入具体日期,则数据为1天:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/unsubscribe?date=2016-03-05

如果请求成功,您将收到回复:

[{"email":"4090797@mail.ru", "unsubscribe_by_link":1, "unsubscribe_by_user":0, "spam_complaint":1, "date":"2018-11-24 19:19:01"}, {"email":"4lik@rambler.ru", "unsubscribe_by_link":1, "unsubscribe_by_user":0, "spam_complaint":1, "date":"2019-03-20 16:47:01"}]

重新订阅收件人

要向联系人发送重新订阅电子邮件,请向以下联系人发送POST请求:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/resubscribe

请求参数:

参数 类型 描述
电子邮件 字符串

收件人邮箱地址

要求
发送方 字符串

寄件人电邮地址

要求
字符串

确认邮件的语言。可能的值:俄文uatr西文pt.默认值:

可选

请注意,从一个帐户,你只能发送5重新订阅请求的电子邮件24小时内

请求示例:

{“电子邮件”:“test@test.com”、“发件人”:“my_sender@test.com”、“朗”:“en”}

如果请求成功,您将收到一个响应:

{"result": true, "id": "pzkic9- 0afesp -fc" //发送邮件id}

获取发件人的IP地址列表

要获得发件人的IP地址列表,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/ips

如果请求成功,您将收到一个响应:

["127.0.0.1"]

获取发件人的电子邮件地址列表

要获得发件人的电子邮件地址列表,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/senders

如果请求成功,您将收到回复:

["sender@domain.com"]

获取允许的域名列表

要获得允许的域的列表,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/domains

如果请求成功,您将收到回复:

["@s开云体育手机网页版登录入口官网endpulse.com"]

添加域

要添加一个域,发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/domains

请求参数:

参数 类型 描述
电子邮件 字符串 寄件人电邮地址 要求

如果请求成功,您将收到回复:

{"result": true}

验证新域

激活和验证一个新域,发送一个GET请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/smtp/domains/ {email}

请求参数:

参数 类型 描述
电子邮件 字符串 寄件人电邮地址 要求

如果请求成功,您将收到回复:

["@s开云体育手机网页版登录入口官网endpulse.com"]

此外,新的域验证码将发送到指定的电子邮件地址。

Baidu
map