创建邮件服务器

POST/zstack/v1/sns/application-platforms/email

Request

cURL

curl --request POST \
  --url '/v1/sns/application-platforms/email' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/sns/application-platforms/email"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "smtpServer": "email.zstack.io",
    "smtpPort": 20.0,
    "username": "example@cloud.io",
    "password": "password",
    "encryptType": "STARTTLS",
    "name": "email platform"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"smtpServer":"email.zstack.io","smtpPort":20.0,"username":"example@cloud.io",
"password":"password","encryptType":"STARTTLS","name":"email platform"}}' \
http://localhost:8080/zstack/v1/sns/application-platforms/email

参数列表

名字	类型	位置	描述	可选值	起始版本
smtpServer	String	body(包含在params结构中)	SMTP服务器地址		2.3
smtpPort	Integer	body(包含在params结构中)	SMTP端口		2.3
username	String	body(包含在params结构中)	用户名		4.1.0
password (可选)	String	body(包含在params结构中)	密码		2.3
name	String	body(包含在params结构中)	资源名称		2.3
description (可选)	String	body(包含在params结构中)	资源的详细描述		2.3
resourceUuid (可选)	String	body(包含在params结构中)			2.3
encryptType (可选)	String	body(包含在params结构中)		SSL STARTTLS NONE	2.3
systemTags (可选)	List	body	系统标签		2.3
userTags (可选)	List	body	用户标签		2.3

添加邮箱服务器时，系统会自动检测用户名、密码、邮箱服务器地址、邮箱服务器端口、加密类型是否正确，等待时间不超过5秒。

API返回

返回示例

{
  "inventory": {
    "uuid": "a5c6d18fdf9b4b6fbdb1f49abce0328c",
    "name": "email platform",
    "description": "example description",
    "state": "Enabled",
    "type": "Email",
    "createDate": "Mar 26, 2024 2:42:32 AM",
    "lastOpDate": "Mar 26, 2024 2:42:32 AM"
  }
}

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	2.3
inventory	SNSApplicationPlatformInventory	详情参考inventory	2.3

error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	2.3
name	String	资源名称	2.3
description	String	资源的详细描述	2.3
type	String	类型	2.3
createDate	Timestamp	创建时间	2.3
lastOpDate	Timestamp	最后一次修改时间	2.3

SDK示例

Java SDK

CreateSNSEmailPlatformAction action = new CreateSNSEmailPlatformAction();
action.smtpServer = "email.zstack.io";
action.smtpPort = 20.0;
action.username = "example@cloud.io";
action.password = "password";
action.encryptType = "STARTTLS";
action.name = "email platform";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateSNSEmailPlatformAction.Result res = action.call();

Python SDK

CreateSNSEmailPlatformAction action = CreateSNSEmailPlatformAction()
action.smtpServer = "email.zstack.io"
action.smtpPort = 20.0
action.username = "example@cloud.io"
action.password = "password"
action.encryptType = "STARTTLS"
action.name = "email platform"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateSNSEmailPlatformAction.Result res = action.call()