OrgEmailSettings
The OrgEmailSettings element defines the email settings for an organization.
Schema
Name
IsDefaultSmtpServer
IsDefaultOrgEmail
FromEmailAddress
DefaultSubjectPrefix
IsAlertEmailToAllAdmins
AlertEmailTo
SmtpServerSettings
SmtpServerSettings
If IsDefaultSmtpServer (in OrgEmailSettings) is false, the SmtpServerSettings element specifies
connection details for the organization's SMTP server.
Schema
Name
IsUseAuthentication
Host
Username
Password
Users
The Users element is a read‐only container for ReferenceType elements that reference users in an
organization. To add users to an organization, see "Create or Import a User" on page 110.
Groups
The Groups element is a read‐only container for ReferenceType elements that reference groups in an
organization. To add groups to an organization, see "Import a Group" on page 113.
Catalogs
The Catalogs element is a read‐only container for ReferenceType elements that reference the catalogs in an
organization. To add catalogs to an organization, see "Create a Catalog" on page 107.
VMware, Inc.
Min
Max
Type
1
1
xs:boolean
1
1
xs:boolean
1
1
xs:string
1
1
xs:string
1
1
xs:boolean
0
n
xs:string
0
1
SmtpServerSettingsType
Min
Max
Type
1
1
xs:boolean
1
1
xs:string
1
1
xs:string
0
1
xs:string
Chapter 11 Administrative API Reference
Description
True if this organization uses the system default
SMTP server
True if this organization uses the system default
email properties.
If IsDefaultOrgEmail is false, specifies the
sender's email address that appears in email
notifications.
If IsDefaultOrgEmail is false, specifies a prefix
for system email notifications.
True if system email notifications should be sent
to all users who have the Administrator role
If IsAlertEmailToAllAdmins is false, specifies
a list of users to receive system email
notifications.
If IsDefaultSmtpServer is False, this element
specifies connection details for an SMTP server
to use.
Description
SMTP server requires authentication
True if the
Hostname of the SMTP server.
Username to use when logging in to the SMTP service.
(Required if IsUseAuthentication is True).
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.
185