VMware Cloud Director API - SmtpSettingsType

SmtpSettingsType

Type:

SmtpSettingsType

Namespace:

http://www.vmware.com/vcloud/extension/v1.5

Description:

The SMTP server for email notifications and alerts.

Since:

1.5

Schema:

settings.xsd

Media type(s):

None

Extends:

ResourceType

XML Representation:

<SmtpSettingsType xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <UseAuthentication> xs:boolean </UseAuthentication>
    <SmtpServerName> xs:string </SmtpServerName>
    <SmtpServerPort> xs:int </SmtpServerPort>
    <vcloud_v1.5:SmtpSecureMode> vcloud_v1.5:SmtpSecureModeType </vcloud_v1.5:SmtpSecureMode>
    <SslTrustStore> xs:string </SslTrustStore>
    <UserName> xs:string </UserName>
    <Password> xs:string </Password>
</SmtpSettingsType>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
href	anyURI	No	always	1.5		The URI of the entity.
type	string	No	always	1.5		The MIME type of the entity.

Elements

Element	Type	Required	Modifiable	Since	Description
Link	LinkType	No	none	1.5	A reference to an entity or operation associated with this object.
Password	string	No		1.5	SMTP admin password. 128 characters or less.
SmtpSecureMode	SmtpSecureModeType	No	always	11.0	Security protocol to use when connecting to the SMTP server. One of: startTls -- Use the STARTTLS protocol ssl -- -Use the SSL/TLS protocol none -- Do not use any security protocol
SmtpServerName	string	No		1.5	SMTP server hostname.
SmtpServerPort	int	No		1.5	SMTP server port.
SslTrustStore	string	No	always	11.0	Custom truststore to use to trust peer certificates when establishing a secure connection using SSL/STARTTLS (when enabled).
UseAuthentication	boolean	Yes		1.5	A flag to indicate if the SMTP requires login authentication. If this flag is set to true, caller must provide user name and password.
UserName	string	No		1.5	SMTP admin user name. 128 characters or less.
VCloudExtension	VCloudExtensionType	No	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.