OrgEmailSettingsType

Element:
OrgEmailSettings
Type:
OrgEmailSettingsType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents the email settings for an organization.
Since:
0.9
Schema:
vCloudEntities.xsd
Media type(s):
application/vnd.vmware.admin.organizationEmailSettings+xml
Extends:
ResourceType
XML Representation:
<OrgEmailSettings xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <IsDefaultSmtpServer> xs:boolean </IsDefaultSmtpServer>
    <IsDefaultOrgEmail> xs:boolean </IsDefaultOrgEmail>
    <FromEmailAddress> xs:string </FromEmailAddress>
    <DefaultSubjectPrefix> xs:string </DefaultSubjectPrefix>
    <IsAlertEmailToAllAdmins> xs:boolean </IsAlertEmailToAllAdmins>
    <AlertEmailTo> xs:string </AlertEmailTo>
    <SmtpServerSettings>
        <IsUseAuthentication> xs:boolean </IsUseAuthentication>
        <Host> xs:string </Host>
        <Port> xs:int </Port>
        <Username> xs:string </Username>
        <Password> xs:string </Password>
    </SmtpServerSettings>
</OrgEmailSettings>

Attributes

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

Elements

Element Type Required Modifiable Since Deprecated Description
AlertEmailTo string No none 0.9 If IsAlertEmailToAllAdmins is false, specifies a list of users to receive system email notifications.
DefaultSubjectPrefix string Yes always 0.9 If IsDefaultOrgEmail is false, specifies a prefix for system email notifications.
FromEmailAddress string Yes always 0.9 If IsDefaultOrgEmail is false, specifies the sender's email address that appears in email notifications.
IsAlertEmailToAllAdmins boolean Yes always 0.9 True if system email notifications should be sent to all users who have the Administrator role.
IsDefaultOrgEmail boolean Yes always 0.9 True if this organization uses the system default email properties.
IsDefaultSmtpServer boolean Yes always 0.9 True if this organization uses the system default SMTP server.
Link LinkType No none 0.9 A reference to an entity or operation associated with this object.
SmtpServerSettings SmtpServerSettingsType No always 0.9 If IsDefaultSmtpServer is false, specifies connection details for an SMTP server to use.
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.

Operations

CRUD Operation Description Since Deprecated
read GET /admin/org/{id}/settings/email Retrieve organization email settings. 1.5
update PUT /admin/org/{id}/settings/email Update organization email settings. 1.5