Versions Compared

Old Version 11

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


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 Properties, below.

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

...

Property

UI Field Name

Description

Specifications

Required

Anchor
authentication - Email
authentication - Email
authentication

Authentication Required

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

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

N

Anchor
authenticationType - Email
authenticationType - Email
authenticationType

Authentication 

Method of authentication. 

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
authorized - Email
authorized - Email
authorized

Is Authorized

If authenticationType = OAuth 2.0; Specification for whether or not the email connection is authorized.

Boolean; read only

N

Anchor
defaultPwd - Email
defaultPwd - Email

defaultPwd

Password

If type = Outgoing and authenticationType = Password; Password that the Controller will use to connect to the server.


Y (if type is Outgoing and authenticationType is Password)

Anchor
defaultUser - Email
defaultUser - Email

defaultUser

User Name

If type = Outgoing and authenticationType = Password or OAuth 2.0 or if type = Incoming and authenticationType = OAuth 2.0; User Name that the Controller will use to connect to the server.


Y (if type is Outgoing and authenticationType is Password or OAuth 2.0 or if type is Incoming and authenticationType is OAuth 2.0)

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 onlyN

Anchor
exportTable - Email
exportTable - Email
exportTable

n/aRecord table information.read onlyN

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

Anchor
oauthClient - Email
oauthClient - Email
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


<pre> &lt;opswiseGroups&gt;
<opswiseGroups>
&lt;opswiseGroup&gt;group1&lt;/opswiseGroup&gt;
<opswiseGroup>group1</opswiseGroup>
&lt;opswiseGroup&gt;group2&lt;/opswiseGroup&gt; &lt;/opswiseGroups&gt; </pre>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups>
Panel
Html bobswift


 
JSON


html-bobswift
Panel
<pre> 
"opswiseGroups": ["group1","group2"]
</pre>


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
titleNote:
You cannot modify the type after the Email Connection has been created.

Valid Values:
html-bobswift
<ul>
<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Outgoing, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  1

<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Incoming, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  2

</ul>
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 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 See 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 Properties.
 Anchor
Read an Email Connection URI Parameters
Read an Email Connection URI Parameters
Read an Email Connection: URI Parameters
...