Email

Handles email message delivery operations, and audit logging for tracking sent communications

---

Query the list of email

GET

/api/v1/email

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型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

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

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

---

Send email

POST

/api/v1/email

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"outId": "string",

"bizKey": "SIGNUP",

"language": "zh_CN",

"type": "CUSTOM",

"subject": "subject",

"fromAddress": "cloud@xcan.cloud",

"toAddress": [

[

"user1@xcancloud.com",

"user2@xcancloud.com"

]

],

"ccAddress": [

[

"demo@xcancloud.com"

]

],

"verificationCode": true,

"verificationCodeValidSecond": "300",

"sendTenantId": 0,

"sendUserId": 0,

"html": true,

"content": "string",

"templateParams": {

"additionalProperties": {

}

},

"attachments": [

{

"name": "string",

"url": "string"

}

],

"expectedSendDate": "string",

"urgent": "false",

"receiveObjectType": "string",

"receiveObjectIds": [

0

],

"receivePolicyCodes": [

"string"

],

"batch": "true"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/email

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete emails

DELETE

/api/v1/email

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/email

试验场

服务器

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Send the test email to server

POST

/api/v1/email/server/test

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"serverId": 0,

"toAddress": [

[

"james@xcan.cloud"

]

],

"sendTenantId": 0,

"sendUserId": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/email/server/test

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the detail of email

GET

/api/v1/email/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Email id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/email/{id}

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Check the email verification code is valid

GET

/api/v1/email/verificationCode/check

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

bizKey*

Email business key.

类型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*

Verification email address.

类型string

必填

minLength1

verificationCode*

类型string

必填

示例"Email verification code."

maxLength160

minLength1

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/email/verificationCode/check

试验场

服务器

授权

UserHttpBearer

变量

键

值

bizKey*

email*

verificationCode*

示例

cURL

JavaScript

PHP

Python

---