通过 API 发送的子章节

API概述

RealSender 允许您通过 API(应用程序编程接口)发送电子邮件。.

这样,您就可以直接从应用程序发送电子邮件,而无需通过 SMTP(简单邮件传输协议)。我们目前 仅支持 POST 请求


服务器地址:
https://rsXXX-api.realsender.com/mail/send


必填/强制性参数:

范围
描述
apiuser 身份验证用户名
apipass 身份验证密码
发件人电子邮件地址
收件人电子邮件地址
主题 邮件主题
文本 纯文本格式的电子邮件正文
html 邮件正文(HTML格式)

如果一切正常,消息将会发送,您将收到一个肯定的 JSON 响应:
{"success":true}

如果出现错误,您将看到类似这样的信息:
{"success":false,"errorMsgs":["请提供“subject”值。"]}


API详情

API详情

邮件内容必须使用UTF-8 国际字符集发送。为了测试,请在邮件主题中添加“€uro”并提交。如果字符集错误,您将收到以下 JSON 警告:

{"success":false,"errorMsgs":["'subject' 值未正确编码。它必须使用 UTF-8 编码。"]}


根据您是否填写了“text”和“html”字段中的一个或两个,消息将使用以下 “Content-Type”之一发送:

范围
描述
文本 text/plain(纯文本)
html text/html(仅限 html)
文本+HTML 多部分/替代(文本和 HTML)
电子邮件客户端设置将决定显示哪一部分。

非必需/可选参数:

范围
描述
来自姓名 发件人描述
命名 收件人描述
回复 接收回复的电子邮件地址
返回路径 用于接收退信的电子邮件地址
必须位于 RealSender 的授权发件人列表中。
cc 抄送电子邮件地址
ccname 碳副本描述
密送 密送副本电子邮件地址
密送名称 盲抄本描述
要附加的文件 - 可以在表单中多次出现 - 最大 3MB。
文件内容必须是 multipart
/form-data 的一部分。对于 INPUT TYPE=FILE,必须使用 enctype=“multipart/form-data” 进行 HTTP POST 请求。

收件人、抄送和密送的值可以包含单个电子邮件地址,也可以包含以 逗号分隔的电子邮件地址列表
!! 在 RealSender 中,每封电子邮件的收件人总数限制为 25 人(最多可增加到 100 人)。


服务器 的响应 采用 JSON(JavaScript 对象表示法)格式:

描述
回复
邮件已发送 {"成功":true}
邮件未发送 {"success":false,"errorMsgs":["..."]}

API 示例

API示例

使用 PHP 的无 CURL POST 请求方法

<?php $url = 'https://rsXXX-api.realsender.com/mail/send'; $data = array('apiuser' =>'我们提供给您的', 'apipass' => '我们提供给您的', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => '邮件主题', 'text' => '纯文本邮件正文', 'html' => 'HTML格式邮件正文'); // 即使您向 https:// 发送请求,也请使用键 'http'... $options = array( 'http' => array( 'header' => "Content-type: application/x-www-form-urlencoded\r\n", 'method' => 'POST', 'content' => http_build_query($data), ), ); $context = stream_context_create($options); $result = file_get_contents($url, false, $context); var_dump($result); ?>

POST 请求
CURL 方法

curl -d 'apiuser=我们提供给您的用户名&apipass=我们提供给您的密码&from=sender@example.com&to=recipient@example.com&subject=邮件主题&text=纯文本格式的邮件正文&html=HTML格式的邮件正文'https://rsXXX-api.realsender.com/mail/send

API示例及附件

带有附件的 API 示例

使用 PHP 的无 CURL 方式发送带有附件的 POST 请求(最多 5 个附件:attach1、attach2 等)

<?php require_once 'HTTP/Request2.php'; $config = array('use_brackets' =>false, ); $request = new HTTP_Request2('https://rsXXX-api.realsender.com/mail/send', HTTP_Request2::METHOD_POST, $config); $data = array('apiuser' => '我们提供给您的用户', 'apipass' => '我们提供给您的密码', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => '邮件主题', 'text' => '纯文本格式的邮件正文', 'html' => 'HTML 格式的邮件正文'); foreach ($data as $k => $d) { $request->addPostParameter($k, $d); }; $request->addUpload('attach1', './sample.pdf', 'sample.pdf', 'application/pdf'); $request->addUpload('attach2', './sample.txt', 'sample.txt', 'text/plain'); $result = $request->send(); var_dump($result); ?>

带有附件的 POST 请求
CURL 方法

curl -F 'apiuser=我们提供给您的用户名' \ -F 'apipass=我们提供给您的密码' \ -F 'from=sender@example.com' \ -F 'to=recipient@example.com' \ -F 'subject=邮件主题' \ -F 'text=纯文本格式邮件正文' \ -F 'html=HTML格式邮件正文' \ -F 'attach=@sample.pdf;type=application/pdf' \ -F 'attach=@sample.txt;type=text/plain' \ https://rsXXX-api.realsender.com/mail/send