VMware Cloud Director API - SmtpServerSettingsType

VMware Cloud Director API - SmtpServerSettingsType

SmtpServerSettingsType

Type:
SmtpServerSettingsType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Defines connection details for the organization s SMTP server. If IsDefaultSmtpServer (in OrgEmailSettings) is false, the SmtpServerSettings element is taken into account.
Since:
0.9
Schema:
vCloudEntities.xsd
Media type(s):
None
Extends:
VCloudExtensibleType
XML Representation:
<SmtpServerSettingsType xmlns="http://www.vmware.com/vcloud/v1.5">
    <IsUseAuthentication> xs:boolean </IsUseAuthentication>
    <Host> xs:string </Host>
    <Port> xs:int </Port>
    <Username> xs:string </Username>
    <Password> xs:string </Password>
    <SmtpSecureMode> SmtpSecureModeType </SmtpSecureMode>
    <SslTrustStore> xs:string </SslTrustStore>
</SmtpServerSettingsType>

Elements

Element Type Required Modifiable Since Deprecated Description
Host string Yes always 0.9 Hostname of the SMTP server.
IsUseAuthentication boolean Yes always 0.9 True if the SMTP server requires authentication.
Password string No always 0.9 Password for the user identified by Username. This value is never returned by GET. It is inspected on create and modify. On modify, the absence of this element indicates that the password should not be changed. Required if IsUseAuthentication is true.
Port int No always 5.1 Port number of the SMTP server.
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
SslTrustStore string No always 11.0 Custom truststore to use to trust peer certificates when establishing a secure connection using SSL/STARTTLS (when enabled).
Username string Yes always 0.9 Username to use when logging in to the SMTP service. (Required if IsUseAuthentication is True).
VCloudExtension VCloudExtensionType No always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.