App.Email.Send API Docs | The No-Code CURD API Platform

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 Params

Parameter	Type	Required	Default	Note	Description
HTTP_APPKEY	String	Required		MIN: 32	Common Put Your APPKEY
address	ArraySeperated with ;	Required			收件人邮件地址，多个用英文分号隔开
title	String	Required			邮件标题
content	String	Required			邮件内容，使用UTF8编码、HTML格式
CC	ArraySeperated with ;	Optaion			添加抄送，多个用英文分号隔开
BCC	ArraySeperated with ;	Optaion			添加密送，多个用英文分号隔开
configuration	String	Optaion			邮件配置名称，在小白开放平台-邮件服务配置中添加的名称，不传则使用默认配置
attachments	ArrayJSON Format	Optaion	[]		附件，支持多个附件。每一组格式如下： name：必填，显示在邮件里的附件名称，例如：文本.txt data：必填，附件的数据，可以为文本或者是base64编码后的数据或者是远程文件链接 encoding：可选，为text或base64或url，其中text表示文本，base64表示客户端base64编码后传递（适用于图片、PDF非文本等，编码后的数据前面不需要`data:image/gif;base64,`，若是图片需要进行url编码，如把/转成%2F），url表示文件链接示例，`attachments=[{"name":"文本.txt","data":"这是附件里的文本内容"}]`
email_sender	String	Optaion			发件人

API Debug

Submit Type:

Form Data

JSON RAW(application/json;charset=UTF-8)

JSON RAW

KEY	REQUIRED	VALUE
app_key	*Required
address	*Required
title	*Required
content	*Required
CC	Option
BCC	Option
configuration	Option
attachments	Option
email_sender	Option

API Response

KEY	Type	Description
err_code	Int	操作码，0表示发送成功，1表示发送失败，失败原因可查看小白开放平台的日志
err_msg	String	错误提示信息，err_code非0时参考此提示信息

HTTP Response Code

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