EmailSettingsType

Element:
EmailSettings
Type:
EmailSettingsType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Represents system email settings.
Since:
1.5
Schema:
settings.xsd
Media type(s):
application/vnd.vmware.admin.emailSettings+xml
Extends:
ResourceType
XML Representation:
<EmailSettings 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"/>
    <SenderEmailAddress> xs:string </SenderEmailAddress>
    <EmailSubjectPrefix> xs:string </EmailSubjectPrefix>
    <AlertEmailToAllAdmins> xs:boolean </AlertEmailToAllAdmins>
    <AlertEmailTo> xs:string </AlertEmailTo>
    <SmtpSettings 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"/>
        <UseAuthentication> xs:boolean </UseAuthentication>
        <SmtpServerName> xs:string </SmtpServerName>
        <SmtpServerPort> xs:int </SmtpServerPort>
        <ssl> xs:boolean </ssl>
        <UserName> xs:string </UserName>
        <Password> xs:string </Password>
    </SmtpSettings>
</EmailSettings>

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 Deprecated Description
AlertEmailTo string No always 1.5 A comma-separated list of email addresses to send alert messages to.
AlertEmailToAllAdmins boolean Yes always 1.5 True if alert emails should be sent to to all system administrators.
EmailSubjectPrefix string No always 1.5 The prefix used in the email subject line for all email notifications and alerts from the system.
Link LinkType No none 1.5 A reference to an entity or operation associated with this object.
SenderEmailAddress string No always 1.5 Sender email address in an email notification or alert.
SmtpSettings SmtpSettingsType Yes 1.5 The SMTP server for email notifications and alerts.
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.

Operations

CRUD Operation Description Since Deprecated
read GET /admin/extension/settings/email Retrieve system email settings. 1.5
as input PUT /admin/extension/settings/email Update system email settings. 1.5