OrgEmailSettings

Element:

OrgEmailSettings

Type:

OrgEmailSettingsType

Namespace:

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

Description:

Defines 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>
        <Username> xs:string </Username>
        <Password> xs:string </Password>
    </SmtpServerSettings>
</OrgEmailSettings>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	0.9	Contains the URI to the entity.
type	string	No	always	0.9	Contains the type of the entity.

Elements

Element	Type	Occurrence	Modifiable	Since	Description
VCloudExtension	VCloudExtensionType	0..*	always	0.9	An optional extension element that can contain an arbitrary number of elements and attributes.
Link	LinkType	0..*	none	0.9	Optional link to an entity or operation associated with this object.
IsDefaultSmtpServer	boolean	1	always	0.9	True if this organization uses the system default SMTP server.
IsDefaultOrgEmail	boolean	1	always	0.9	True if this organization uses the system default email properties.
FromEmailAddress	string	1	always	0.9	If IsDefaultOrgEmail is false, specifies the sender s email address that appears in email notifications.
DefaultSubjectPrefix	string	1	always	0.9	If IsDefaultOrgEmail is false, specifies a prefix for system email notifications.
IsAlertEmailToAllAdmins	boolean	1	always	0.9	True if system email notifications should be sent to all users who have the Administrator role.
AlertEmailTo	string	0..*	none	0.9	If IsAlertEmailToAllAdmins is false, specifies a list of users to receive system email notifications.
SmtpServerSettings	SmtpServerSettingsType	0..1	always	0.9	If IsDefaultSmtpServer is false, this element specifies connection details for an SMTP server to use.

Operations

CRUD	Operation	Description	Since
read	GET /admin/org/{id}/settings/email	Retrieves email settings for an organization.	1.5
update	PUT /admin/org/{id}/settings/email	Updates email policy settings for organization.	1.5