CreateSNSEmailPlatform

API Request

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

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

Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

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@zstack.io","password":"password","encryptType":"STARTTLS","name":"email platform"}}' \
http://localhost:8080/zstack/v1/sns/application-platforms/email

Request Parameters


Name	Type	Location	Description	Optional Value	Starting Version
smtpServer	String	body (contained in the params structure)	The SMTP server address.		2.3
smtpPort	Integer	body (contained in the params structure)	The SMTP port.		2.3
username	String	body (contained in the params structure)	The username.		2.3
password	String	body (contained in the params structure)	Optional. The password.		2.3
name	String	body (contained in the params structure)	The resource name.		2.3
description	String	body (contained in the params structure)	Optional. The detailed description of the resource.		2.3
resourceUuid	String	body (contained in the params structure)	Optional.		2.3
encryptType	String	body (contained in the params structure)	Optional.	SSL STARTTLS NONE	2.3
systemTags	List	body	Optional. The system tags.		2.3
userTags	List	body	Optional. The user tags.		2.3

Note:

When you add an email server, the system will automatically detect whether the username, password, email server address, email server port, and encryption type are correct. The waiting time does not exceed 5 seconds.

API Response

Sample Response

{
  "inventory": {
    "uuid": "f6122105d8994b498e6184efcf03bb64",
    "name": "email platform",
    "description": "example description",
    "state": "Enabled",
    "type": "Email",
    "createDate": "Feb 28, 2018 9:47:35 AM",
    "lastOpDate": "Feb 28, 2018 9:47:35 AM"
  }
}


Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	2.3
inventory	SNSApplicationPlatformInventory	See inventory.	2.3

#error


Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	0.6
description	String	The brief description of the error.	0.6
details	String	The details about the error.	0.6
elaboration	String	The reserved field. Default value: null.	0.6
opaque	LinkedHashMap	The reserved field. Default value: null.	0.6
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	0.6

#inventory


Name	Type	Description	Starting Version
uuid	String	The resource UUID.	2.3
name	String	The resource name.	2.3
description	String	The detailed description of the resource.	2.3
type	String	The type.	2.3
createDate	Timestamp	The creation date.	2.3
lastOpDate	Timestamp	The last operation date.	2.3

SDK Sample

Java SDK

CreateSNSEmailPlatformAction action = new CreateSNSEmailPlatformAction();
action.smtpServer = "email.zstack.io";
action.smtpPort = 20.0;
action.username = "example@zstack.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@zstack.io"
action.password = "password"
action.encryptType = "STARTTLS"
action.name = "email platform"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateSNSEmailPlatformAction.Result res = action.call()