EmailSettings

Element:
EmailSettings
Type:
EmailSettingsType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Represent all the email related settings in the system.
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 Description
href anyURI No always 1.5 Contains the URI to the entity.
type string No always 1.5 Contains the type of the entity.

Elements

Element Type Occurrence Modifiable Since Description
VCloudExtension VCloudExtensionType 0..* always 1.5 An optional extension element that can contain an arbitrary number of elements and attributes.
Link LinkType 0..* none 1.5 Optional link to an entity or operation associated with this object.
SenderEmailAddress string 0..1 always 1.5 Sender email address in an email notification or alert.
EmailSubjectPrefix string 0..1 always 1.5 The prefix used in the email subject line for all email notifications and alerts from the system.
AlertEmailToAllAdmins boolean 1 always 1.5 A flag to indicate the choice between sending alert emails to all system administrators in the system and designated list of email recipients.
AlertEmailTo string 0..1 always 1.5 A comma separated email addresses to send all alert messages to.
SmtpSettings SmtpSettingsType 1 1.5 The SMTP server for email notifications and alerts.

Operations

CRUD Operation Description Since
read GET /admin/extension/settings/email Retrieves the {@link EmailSettings}. 1.5
as input PUT /admin/extension/settings/email Updates the {@link EmailSettings}. 1.5