发送测试邮件

POST/zstack/v1/sns/application-endpoints/email/test-connection

Request

cURL

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

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "emails": [
      "example@zstack.io"
    ],
    "platformUuid": "d5904b92d6df39a5905212bde24b2946",
    "endpointUuid": "2ff88c96f20f36469bdfcd2fa84e533d",
    "subject": "test email subject",
    "text": "this is a test email of content"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"emails":["example@zstack.io"],"platformUuid":"d5904b92d6df39a5905212bde24b2946","endpointUuid":"2ff88c96f20f36469bdfcd2fa84e533d","subject":"test email subject","text":"this is a test email of content"}}' \
http://localhost:8080/zstack/v1/sns/application-endpoints/email/test-connection

参数列表

名字	类型	位置	描述	起始版本
emails (可选)	List	body(包含在`params`结构中)	接收邮箱地址接	4.10.0
platformUuid (可选)	String	body(包含在`params`结构中)	邮箱平台uuid	4.10.0
endpointUuid (可选)	String	body(包含在`params`结构中)	邮箱端点uuid	4.10.0
subject (可选)	String	body(包含在`params`结构中)	主题	4.10.0
text (可选)	String	body(包含在`params`结构中)	内容	4.10.0
systemTags (可选)	List	body	系统标签	4.10.0
userTags (可选)	List	body	用户标签	4.10.0

API返回

返回示例

{
  "connected": true,
  "webhookResp": {}
}

名字	类型	描述	起始版本
success	boolean		4.10.0
connected	boolean	发送结果	4.10.0
webhookResp	LinkedHashMap	对端响应内容	4.10.0
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.10.0

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

SDK示例

Java SDK

SNSEmailTestConnectionAction action = new SNSEmailTestConnectionAction();
action.emails = asList("example@zstack.io");
action.platformUuid = "d5904b92d6df39a5905212bde24b2946";
action.endpointUuid = "2ff88c96f20f36469bdfcd2fa84e533d";
action.subject = "test email subject";
action.text = "this is a test email of content";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SNSEmailTestConnectionAction.Result res = action.call();

Python SDK

SNSEmailTestConnectionAction action = SNSEmailTestConnectionAction()
action.emails = [example@zstack.io]
action.platformUuid = "d5904b92d6df39a5905212bde24b2946"
action.endpointUuid = "2ff88c96f20f36469bdfcd2fa84e533d"
action.subject = "test email subject"
action.text = "this is a test email of content"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SNSEmailTestConnectionAction.Result res = action.call()