OkayAPI Docs


API Path: /api/App/Email/Send

API Description: 发送邮件到指定的邮箱,支持发送附件。使用前需要先在小白开放平台配置邮箱服务

3
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
addressArraySeperated with ;Required收件人邮件地址,多个用英文分号隔开
titleStringRequired邮件标题
contentStringRequired邮件内容,使用UTF8编码、HTML格式
CCArraySeperated with ;Optaion添加抄送,多个用英文分号隔开
BCCArraySeperated with ;Optaion添加密送,多个用英文分号隔开
configurationStringOptaion邮件配置名称,在小白开放平台-邮件服务配置中添加的名称,不传则使用默认配置
attachmentsArrayJSON FormatOptaion[]附件,支持多个附件。每一组格式如下:
  • name:必填,显示在邮件里的附件名称,例如:文本.txt
  • data:必填,附件的数据,可以为文本或者是base64编码后的数据或者是远程文件链接
  • encoding:可选,为text或base64或url,其中text表示文本,base64表示客户端base64编码后传递(适用于图片、PDF非文本等,编码后的数据前面不需要data:image/gif;base64,,若是图片需要进行url编码,如把/转成%2F),url表示文件链接
示例,attachments=[{"name":"文本.txt","data":"这是附件里的文本内容"}]
email_senderStringOptaion发件人

API Debug

KEYREQUIREDVALUE
app_key *Required
address *Required
title *Required
content *Required
CC Option
BCC Option
configuration Option
attachments Option
email_sender Option

API Response

KEYTypeDescription
err_codeInt操作码,0表示发送成功,1表示发送失败,失败原因可查看小白开放平台的日志
err_msgString错误提示信息,err_code非0时参考此提示信息

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error