EmailServer

Email server configuration management, authentication protocols, and delivery policies to ensure reliable, compliant email communication across systems

---

Query the list of email server

GET

/api/v1/email/server

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

name

类型string

protocol

类型string

枚举

"SMTP""POP3""IMAP"

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/server

试验场

服务器

授权

UserHttpBearer

变量

键

值

id

name

protocol

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

---

Replace email server

PUT

/api/v1/email/server

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 1,

"name": "XCan Email Server",

"protocol": "string",

"remark": "string",

"host": "smtp.xcancloud.com",

"port": 465,

"startTlsEnabled": "true",

"sslEnabled": "true",

"authEnabled": "true",

"authAccount": {

"account": "test@xcan.cloud",

"password": "xcan@123"

},

"subjectPrefix": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/email/server

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add email server

POST

/api/v1/email/server

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"name": "XCan Email Server",

"protocol": "string",

"remark": "string",

"host": "smtp.xcancloud.com",

"port": 465,

"startTlsEnabled": "true",

"sslEnabled": "true",

"authEnabled": "true",

"authAccount": {

"account": "test@xcan.cloud",

"password": "xcan@123"

},

"subjectPrefix": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/email/server

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete email server

DELETE

/api/v1/email/server

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

maxItems10

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/email/server

试验场

服务器

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Update email server

PATCH

/api/v1/email/server

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"name": "XCan Email Server",

"protocol": "string",

"remark": "string",

"host": "smtp.xcancloud.com",

"port": 465,

"startTlsEnabled": true,

"sslEnabled": true,

"authEnabled": true,

"authAccount": {

"account": "test@xcan.cloud",

"password": "xcan@123"

},

"subjectPrefix": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/email/server

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Enable or disable email server

PATCH

/api/v1/email/server/enabled

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 1,

"enabled": true

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/email/server/enabled

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the detail of email server

GET

/api/v1/email/server/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Email server ID

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/email/server/{id}

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Check the enabled email server

GET

/api/v1/email/server/check

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

protocol

Mail server protocol, only SMTP is supported

类型string

枚举

"SMTP""POP3""IMAP""SMTP"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/email/server/check

试验场

服务器

授权

UserHttpBearer

变量

键

值

protocol

示例

cURL

JavaScript

PHP

Python

---