[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Test Email Settings

Description

Tests that Email SMTP Settings are valid

Request

Request

URL

URL


post
https://{api_host}/cloudapi/1.0.0/smtp/test
Copy

Request Body

Request Body

TestEmailRequest of type(s) application/json Required

Email Settings and destination email address for Email Test call

{
	"destination": "string",
	"emailSettings": {
		"alertEmailTo": "string",
		"alertEmailToAllAdmins": false,
		"defaultEmailSubjectPrefix": "string",
		"defaultOrgEmail": false,
		"defaultSmtpServer": false,
		"senderEmailAddress": "string",
		"smtpServer": {
			"description": "string",
			"name": "string",
			"password": "string",
			"secureMode": "NONE",
			"sslTrustStore": "string",
			"url": {
				"host": "string",
				"port": 0,
				"ssl": false
			},
			"useAuthentication": false,
			"userName": "string"
		}
	}
}
string
destination Optional

emailSettings Optional

Email related settings for a system

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

204 No Content

OK

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"destination":"string","emailSettings":{"alertEmailTo":"string","alertEmailToAllAdmins":false,"defaultEmailSubjectPrefix":"string","defaultOrgEmail":false,"defaultSmtpServer":false,"senderEmailAddress":"string","smtpServer":{"description":"string","name":"string","password":"string","secureMode":"NONE","sslTrustStore":"string","url":{"host":"string","port":0,"ssl":false},"useAuthentication":false,"userName":"string"}}}' https://{api_host}/cloudapi/1.0.0/smtp/test


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?