...

Universal Controller supports the following RESTful-based web services for Email Connection operations, which are listed alphabetically on this page.

Email Connection Web Services#Create Create an Email ConnectionEmail Connection Web Services#Delete
Delete an Email Connection
Email Connection Web Services#List List Email ConnectionsEmail
Connection Web Services#Modify Modify an Email ConnectionEmail Connection Web Services#Read
Read an Email Connection

Formatting specifications for each web service, including details about property requirements, are provided.

...

	Description
URI	http://host_name/uc/resources/emailconnection
HTTP Method	POST
Description	Creates an Email Connection.
Example URI	http://localhost:8080/uc/resources/emailconnection
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Create an Email Connection: Example Request, below.
Example Response	Status 200 /OK Successfully created the Email Connection with sysId {sysId}. Status 400 /Bad Request Create Email Connection failed. A duplicate value has been detected. Name must be unique.
Email Connection Properties	See Email Connection Web Services#Email Connection Properties, below.

Anchor
Create an Email Connection Example Request
Create an Email Connection Example Request
Create an Email Connection: Example Request

...

Anchor
Email Connection Properties
Email Connection Properties
Email Connection Properties

Property	UI Field Name	Description	Specifications	Required
`authenticationType`

anchor

Authentication

Method of authentication

- Emailauthentication - Emailauthentication

Authentication Required

If type = Outgoing; Specification for whether or not defaultUser and password are required.

Boolean; Valid values: true/false. Default is false.

.

Valid values (case-insensitive):

As String = None, As Value = 0
As String = Password, As Value = 1
As String = OAuth 2.0, As Value = 2

N

Anchor

	defaultPwd - Email
	defaultPwd - Email

defaultPwd

Password

If authentication =

true

Password; Password that the Controller will use to connect to the server.

If defaultPwd is omitted in the request, it will be ignored.
If defaultPwd is provided in the request, it will be updated.

N

Anchor

	defaultUser - Email
	defaultUser - Email

defaultUser

User Name

If authentication = true;

User name that the Controller will use to connect to the server.

N

Anchor

	description - Email
	description - Email

description

Description

Description of this record.

N

Anchor

	emailAddr - Email
	emailAddr - Email

emailAddr

Email Address

If type = Outgoing; Email address of the sender.

Y

Anchor

	exportReleaseLevel - Email
	exportReleaseLevel - Email

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

	exportTable - Email
	exportTable - Email

exportTable

n/a

Record table information.

read only

N

Anchor

	imap - Email
	imap - Email

imap

Incoming Mail Server (IMAP)

If type = Incoming; Name or IP address of the incoming email server.

Y

Anchor

	imapPort - Email
	imapPort - Email

imapPort

IMAP Port

If type = Incoming; Port on the machine where the incoming email server resides.

Y

Anchor

	imapSsl - Email
	imapSsl - Email

imapSsl

Enable SSL

If type = Incoming; Specification for whether or not SSL/TLS connectivity is enabled for your server.

Boolean; Valid values: true/false. Default is false.

N

Anchor

	imapStarttls - Email
	imapStarttls - Email

imapStarttls

Enable STARTTLS

If type = Incoming; Specification for whether or not the use of the STARTTLS command (if supported by the server) is enabled to switch the connection to a TLS-protected connection before issuing any login commands. (An appropriate trust store must be configured so that the client will trust the server's certificate. )

N

Anchor

	name - Email
	name - Email

name

Connection Name

Name used within the Controller to identify this Email Connection.

Y

oauthClient

OAuth Client

The OAuth client used to authorize the email connection.

Y (if authenticationType is OAuth 2.0)

Anchor

	opswiseGroups - Email
	opswiseGroups - Email

opswiseGroups

Member of Business Services

Business Services that this record belongs to.

XML

Panel

JSON

Panel

N

Anchor

	smtp - Email
	smtp - Email

smtp

Outgoing Mail Server (SMTP)

If type = Outgoing; Name or IP address of the outgoing email server.

Y

Anchor

	smtpPort - Email
	smtpPort - Email

smtpPort

SMTP Port

If type = Outgoing; Port on the machine where the outgoing email server resides.

Y

Anchor

	smtpSsl - Email
	smtpSsl - Email

smtpSsl

Enable SSL

If type = Outgoing; Specification for whether or not SSL/TLS connectivity is enabled for your server.

Boolean; Valid values: true/false. Default is false.

N

Anchor

	smtpStarttls - Email
	smtpStarttls - Email

smtpStarttls

Enable STARTTLS

If type = Outgoing; Specification for whether or not the use of the STARTTLS command (if supported by the server) is enabled to switch the connection to a TLS-protected connection before issuing any login commands. (An appropriate trust store must be configured so that the client will trust the server's certificate. )

N

Anchor

	sysId - Email
	sysId - Email

sysId

n/a

System ID field in the database for this Email Connection record.

Persisted only if retainSysIds is set to true.

N

Anchor

	systemConnection - Email
	systemConnection - Email

systemConnection

Use for System Notifications

If type = Outgoing; Specification for whether or not this Email Connection is to be used for system notifications.

Boolean; Valid values: true/false. Default is false.

Y

Anchor

	trashFolder- Email
	trashFolder- Email

trashFolder

Trash Folder

If type = Incoming; Folder to use for deleted emails.

N

Anchor

	type - Email
	type - Email

type

Connection Type

Type of Email Connection.

Note

title	Note:

You cannot modify the type after the Email Connection has been created.

Valid Values:

Default is Outgoing (1)

Y

Anchor
Delete an Email Connection
Delete an Email Connection
Delete an Email Connection

...

	Description
URI	http://host_name/uc/resources/emailconnection/list
HTTP Method	GET
Description	Retrieves information on all Email Connections.
Example URI	http://localhost:8080/uc/resources/emailconnection/list
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	See List Email Connections: Example Response, below.
Email Connection Properties	See Email Connection Web Services#Email Connection Properties.

Anchor
List Email Connections Example Response
List Email Connections Example Response
List Email Connections: Example Response

...

	Description
URI	http://host_name/uc/resources/emailconnection
HTTP Method	PUT
Description	Modifies the Email Connection specified by the `sysId`.
Example URI	http://localhost:8080/uc/resources/emailconnection
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Modify an Email Connection: Example Request, below.
Email Connection Properties	See Email Connection Web Services#Email Connection Properties.
Example Response	Status 200 /OK Successfully updated the Email Connection with sysId <sysId> to version <version>.

...

URI	http://host_name/uc/resources/emailconnection
HTTP Method	GET
Description	Retrieves information on a specific Email Connection.
URI Parameters	See Read an Email Connection: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/emailconnection?connectionname=Test4
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	See Read an Email Connection: Example Response, below.
Email Connection Properties	See Email Connection Web Services#Email Connection Properties.

Anchor
Read an Email Connection URI Parameters
Read an Email Connection URI Parameters
Read an Email Connection: URI Parameters

...

Versions Compared

Old Version 1

New Version 2

Key

Anchor
Create an Email Connection Example Request
Create an Email Connection Example Request
Create an Email Connection: Example Request

Anchor
Email Connection Properties
Email Connection Properties
Email Connection Properties

Anchor
Delete an Email Connection
Delete an Email Connection
Delete an Email Connection

Anchor
List Email Connections Example Response
List Email Connections Example Response
List Email Connections: Example Response

Anchor
Read an Email Connection URI Parameters
Read an Email Connection URI Parameters
Read an Email Connection: URI Parameters

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

AnchorCreate an Email Connection Example RequestCreate an Email Connection Example RequestCreate an Email Connection: Example Request

AnchorEmail Connection PropertiesEmail Connection PropertiesEmail Connection Properties

AnchorDelete an Email ConnectionDelete an Email ConnectionDelete an Email Connection

AnchorList Email Connections Example ResponseList Email Connections Example ResponseList Email Connections: Example Response

AnchorRead an Email Connection URI ParametersRead an Email Connection URI ParametersRead an Email Connection: URI Parameters

Anchor
Create an Email Connection Example Request
Create an Email Connection Example Request
Create an Email Connection: Example Request

Anchor
Email Connection Properties
Email Connection Properties
Email Connection Properties

Anchor
Delete an Email Connection
Delete an Email Connection
Delete an Email Connection

Anchor
List Email Connections Example Response
List Email Connections Example Response
List Email Connections: Example Response

Anchor
Read an Email Connection URI Parameters
Read an Email Connection URI Parameters
Read an Email Connection: URI Parameters