邮件

处理邮件消息的传递操作，并提供用于追踪已发送通信的审计日志记录功能

---

检查邮箱验证码是否有效

GET

/api/v1/email/verificationCode/check

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

bizKey*

邮件业务键

类型string

必填

枚举

"EVENT_NOTICE""SIGNUP""SIGNIN""PASSWORD_FORGET""PASSWORD_UPDATE""SIGN_CANCEL""MODIFY_EMAIL""BIND_EMAIL""PAY_PASSWORD_UPDATE""REALNAME_AUTH_SUBMIT""REALNAME_AUTH_PASSED""REALNAME_AUDIT_FAILURE""SYS_EXCEPTION_NOTICE""SYS_RECOVERY_NOTICE""SYS_SECURITY_NOTICE""LICENSE_SENT""CHANNEL_TEST""TODO_REALNAME_AUTH""TODO_BUSINESS_CONSULTATION""TODO_OFFLINE_SERVICE""TODO_WORKORDER""TODO_TRANSFER_CONFIRM""TODO_INVOICE_CONFIRM""TODO_WITHDRAW_CONFIRM""RECHARGE_SUCCESS""WITHDRAW_SUCCESS""ORDER_PAY_SUCCESS""ORDER_PAY_PENDING""ORDER_PAY_TIMEOUT""ORDER_TO_EXPIRE""ORDER_CHANGE_SUCCESS""WORKORDER_REPLY_REMINDER""INVOICE_APPLY_SUCCESS""COUPON_DISTRIBUTION""COUPON_TO_EXPIRE""BLOG_SUBSCRIPTION_NOTICE""TESTING_EXEC_STARTED""TESTING_EXEC_FINISHED""TESTING_EXEC_FAILED""TESTING_TASK_OVERDUE""INDICATOR_MODIFY_SUBMIT""INDICATOR_AUDIT_PASSED""INDICATOR_AUDIT_FAILED"

示例"SIGNUP"

email*

验证邮箱地址。

类型string

必填

minLength1

verificationCode*

类型string

必填

示例"Email verification code."

maxLength160

minLength1

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/email/verificationCode/check

试验场

授权

UserHttpBearer

变量

键

值

bizKey*

email*

verificationCode*

示例

cURL

JavaScript

PHP

Python

---

查询邮件详情

GET

/api/v1/email/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

邮箱ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/email/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

向服务器发送测试邮件

POST

/api/v1/email/server/test

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/email/server/test

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

查询邮件列表

GET

/api/v1/email

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

templateCode

类型string

language

类型string

bizKey

类型string

枚举

"SIGNUP""SIGNIN""PASSWORD_FORGET""PASSWORD_UPDATE""SIGN_CANCEL""MODIFY_MOBILE""BIND_MOBILE""PAY_PASSWORD_UPDATE""REALNAME_AUTH_SUBMIT""REALNAME_AUTH_PASSED""REALNAME_AUDIT_FAILURE""SYS_EXCEPTION_NOTICE""SYS_RECOVERY_NOTICE""SYS_SECURITY_NOTICE""LICENSE_SENT""CHANNEL_TEST""TODO_REALNAME_AUTH""TODO_BUSINESS_CONSULTATION""TODO_OFFLINE_SERVICE""TODO_WORKORDER""TODO_TRANSFER_CONFIRM""TODO_INVOICE_CONFIRM""TODO_WITHDRAW_CONFIRM""RECHARGE_SUCCESS""WITHDRAW_SUCCESS""ORDER_PAY_SUCCESS""ORDER_PAY_PENDING""ORDER_PAY_TIMEOUT""ORDER_TO_EXPIRE""ORDER_CHANGE_SUCCESS""WORKORDER_REPLY_REMINDER""TESTING_EXEC_STARTED""TESTING_EXEC_FINISHED""TESTING_EXEC_FAILED""TESTING_TASK_OVERDUE""INDICATOR_MODIFY_SUBMIT""INDICATOR_AUDIT_PASSED""INDICATOR_AUDIT_FAILED""EVENT_NOTICE"

outId

类型string

emailType

类型string

枚举

"TEMPLATE""CUSTOM"

html

类型boolean

verificationCode

类型boolean

batch

类型boolean

sendTenantId

类型integer

format"int64"

sendUserId

类型integer

format"int64"

urgent

类型boolean

sendStatus

类型string

枚举

"PENDING""SUCCESS""FAILURE"

expectedSendDate

类型string

format"date-time"

actualSendDate

类型string

format"date-time"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

排序字段

类型string

orderSort

排序方法

类型string

枚举

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

枚举

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/email

试验场

授权

UserHttpBearer

变量

键

值

id

templateCode

language

bizKey

outId

emailType

html

verificationCode

batch

sendTenantId

sendUserId

urgent

sendStatus

expectedSendDate

actualSendDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

发送邮件

POST

/api/v1/email

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/email

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

删除邮件

DELETE

/api/v1/email

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/email

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---