电子邮件发送 API

用途

该 API 用于发送事务性电子邮件。

请求 URL

https://api.zeptomail.com/v1.1/email

授权令牌

您需要添加发送邮件令牌以验证 API 请求。这是 ZeptoMail 帐户中的唯一令牌，您可以在邮件代理中生成该令牌。调用 ZeptoMail REST 电子邮件发送 API 时，使用发送邮件令牌作为标头。

例如

POST /v1.1/email

查询字符串：

POST
HOST: https://api.zeptomail.com
Header:
Authorization: zoho-enczapikey <space> <send mail token>

关于生成发送邮件令牌的步骤：

导航至 ZeptoMail 帐户左侧面板上的“邮件代理”选项卡，然后选择要连接到应用程序的邮件代理。
在右上角单击“SMTP 和 API 信息”（齿轮图标）。这将打开“设置详细信息”页面。
从此处，您可以在 API 选项卡下复制您的邮件代理特定的发送邮件令牌。
您可以使用默认的发送邮件令牌，也可以生成新令牌。

邮件代理 >> SMTP 和 API 信息 >> 发送邮件令牌 >> 单击以复制图标

请求正文

* - 必需参数

参数	数据类型	说明
bounce_address*	字符串	退回电子邮件将发送到的电子邮件地址。允许的值 - 在邮件代理中配置的有效退回电子邮件地址。
from*	JSON 对象	允许的值 - 具有“address”和“name”键值对的有效发件人电子邮件地址。
address	字符串	包含邮件代理中经过验证的域的有效电子邮件地址。
name	字符串	发件人名称。
to*	JSON 数组	允许的值 - email_address 的 JSON 对象。
email_address	JSON 对象	具有“address”和“name”键值对的有效收件人电子邮件地址。
address	字符串	收件人的电子邮件地址字段。
name	字符串	收件人名称。
reply_to	JSON 数组	允许的值 - reply_to 电子邮件地址的 JSON 对象。
address	字符串	收件人的电子邮件回复将发送到的电子邮件地址。允许的值 - 包含邮件代理中经过验证的域的有效电子邮件地址。
name	字符串	reply-to 参数的名称。
subject*	字符串	要发送的电子邮件的主题。
textbody / htmlbody	字符串	这是电子邮件的正文内容。允许的值您的电子邮件正文可以是 textbody，也可以是 htmlbody。
cc	JSON 数组	抄送收件人的电子邮件地址。允许的值 - email_address 的 JSON 对象。
bcc	JSON 数组	密件抄送收件人的电子邮件地址。允许的值 - email_address 的 JSON 对象。
track_clicks	布尔值	您可以在此处启用或禁用电子邮件点击跟踪。您还可以在邮件代理的“电子邮件跟踪”部分启用电子邮件点击跟踪。注意：API 设置将覆盖 ZeptoMail 帐户中的邮件代理设置。允许的值 True - 启用电子邮件点击跟踪。 False - 禁用电子邮件点击跟踪。
track_opens	布尔值	您可以启用或禁用电子邮件打开跟踪。您也可以在邮件代理的“电子邮件跟踪”部分启用电子邮件打开跟踪。注意：API 设置将覆盖 ZeptoMail 帐户中的邮件代理设置。允许的值 True - 启用电子邮件打开跟踪。 False - 禁用电子邮件打开跟踪。
client_reference	字符串	用户为跟踪特定事务而设置的标识符。
mime_headers	JSON 对象	在电子邮件中发送的附加标题，供您参考。
attachments	JSON 数组	要添加到事务性电子邮件的附件。单击此处查看不支持的格式列表。允许的值 - 附件的 JSON 对象。可以是 base64 编码的内容和/或 file_cache_key。
content	字符串	附件的内容。允许的值 - 文件的 Base64 编码值。
mime_type	字符串	指示附件中的内容类型。允许的值简单文本消息 - 纯文本/文本 image 文件 - 图片/jpg
name		附件的文件名。
file_cache_key	字符串	邮件代理中附加文件的唯一密钥。从邮件代理的“文件缓存”部分获取 file_cache_key。
name	字符串	附件的文件名，与邮件代理的“文件缓存”部分中的文件名一致。从邮件代理的“文件缓存”部分获取文件名。
inline_images	JSON 数组	这是添加到电子邮件中的内联图像。允许的值可以是 base64 编码的内容和/或 file_cache_key。 base64 内容包含 mime_type、content 和 cid 参数。
cid	字符串	html 正文用于内容查找的内容 ID。每个内容都应具有单独的 cid 值。允许的值可以是base64 编码的内容和/或 file_cache_key。

成功响应参数

参数	数据类型	说明
data	JSON 数组	它由 code、additional _info 和 message 参数组成
code	字符串	与成功响应对应的代码
additional_info	JSON 数组	提供有关请求中执行的操作的附加信息
message	字符串	针对此请求执行的操作
message	字符串	请求的状态
request_id	字符串	为每个请求生成的唯一 ID
object	电子邮件	它表示响应针对的是电子邮件 API

失败响应参数

参数	数据类型	说明
error	JSON 对象	它由 code、details、message 和 request_id 参数组成
code	字符串	与请求状态对应的代码
details	JSON 数组	它由 code、message 和 target 参数组成
code	字符串	所发现的错误的代码
message	字符串	错误原因
target	字符串	导致错误的字段
message	字符串	请求的状态
request_id	字符串	为每个请求生成的唯一 ID

HTTP 状态代码

状态代码	说明
2xx	成功
4xx	失败。需要在用户端执行操作来修复错误。
5xx	失败。需要在 ZeptoMail 服务器端执行操作来修复错误。

错误代码

注意：

在您开始之前，请务必了解 ZeptoMail 用于发送诸如欢迎邮件、密码重置电子邮件、OTP 等事务性电子邮件。我们不支持发送批量电子邮件或促销电子邮件（例如，时事通讯或营销活动电子邮件）。如果您正在寻找批量电子邮件提供商，可以访问 Zoho Campaigns。

Curl 请求详细信息


				curl "https://api.zeptomail.com/v1.1/email" \
-X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-enczapikey ***" \
-d {"
bounce_address:bounces@info.zylker.com,
from: { 'address': 'accounts@info.zylker.com',  'name': 'Paula'},
to: [{'email_address': {'address': 'rudra.d@zylker.com','name': 'Rudra'}}],
subject:帐户确认, 
htmlbody:&apos;<div><b>请单击&ldquo;验证帐户&rdquo;以确认您的帐户</b></div>&apos;}&quot;

示例输入

这是 API JSON 格式示例


				{
"bounce_address": "bounces@info.zylker.com",
"from": 
  {
  "address": "accounts@info.zylker.com",
  "name": "Paula"
  },
"to": 
  [
    {
    "email_address": 
      {
      "address": "rudra.d@zylker.com",
      "name": "Rudra"
      }
    } 
  ],
"reply_to": 
  [
      {
      "address": "rudra.d@zylker.com",
      "name": "Rudra"
      } 
  ],
"subject": "Account Confirmation",
&quot;textbody&quot;: &quot;请单击&ldquo;验证帐户&rdquo;以确认您的帐户&quot;, &quot;htmlbody&quot;: &quot;<html>
<META http-equiv="content-type" content="text/html; charset=utf-8"><body>您好，请验证您的帐户以开始接收报告<img src=\"cid:img-welcome-design\">scdjsncj<img src=\"cid:img-CTA\"><h1><a href=\"http:/>www.zylker.com/cache-bin\&quot;&gt;验证帐户</a></h1></body></html>
"cc": 
  [
    {
    "email_address": 
      {
      "address": "rebecca@zylker.com",
      "name": "Rebecca"
      }
    }
  ],
"bcc": 
  [
    {
    "email_address": 
      {
      "address": "helen@zylker.com",
      "name": "helen"
      }
    }
  ],
"track_clicks": true,
"track_opens": true,
"client_reference": "83783/8369423/2882",
"mime_headers": 
  {
  "X-Zylker-User": "rebecca-72893"
  },
"attachments": 
  [
    {
    "content": "..x+SEXa3zKfnDnBA2qExtXikBpUAFABQAhGSPY/0IoAWgD/2Q==",
    "mime_type": "image/jpg",
    "name": "DM-welcome-guide"
    },
    {
    "file_cache_key": "ea36f19a.37b62c9.h1.dd2cb7e0-337f-11ea-afc1-7e55a3f36c77.16f8e7bf1b8",
    "name": "DM-reports"
    }
  ],
"inline_images": 
  [
    {
    "mime_type": "image/jpg",
    "content": "...x+SEXa3zKfnDnBA2qExtXikBpUAFABQAhGSPY/0IoAWgD/2Q==",
    "cid": "img-welcome-design"
    },
    {
    "file_cache_key": "ea36f19a.37b62c9.h1.f20ca6c0-337f-11ea-afc1-7e55a3f36c77.16f8e7c7afb",
    "cid": "img-CTA"
    }
  ]
}

示例成功响应


				{
"data":
  [
    {
    "code": "EM_101",
    "additional_info": [],
    "message": "Email queued"
    }
  ],
"message": "OK",
"request_id": "d7624ab4.7a1fa6.i1.83b51de0-56d1-11ea-a70b-4ad472469664.17075f34ebe",
"object": "email"
}

示例失败响应


				{
"error": 
  {
  "code": "TM_4001",
  "details": 
    [
    {
    "code": "SM_113",
    "message": "Invalid email address",
    "target": "bounce_address"
    }
  ],
"message": "Access Denied",
"request_id": "ea36f19a.37b62c9.m1.83fdb210-56f1-11ea-bcae-863166d285e5.17076c507b1"
  }
}