Email Connection Web Services
Overview
Universal Controller supports the following RESTful-based web services for Email Connection operations, which are listed alphabetically on this page.
- Create an Email Connection
- Delete an Email Connection
- List Email Connections
- Modify an Email Connection
- Read an Email Connection
Formatting specifications for each web service, including details about property requirements, are provided.
Create an Email Connection
|
Description |
---|---|
URI |
|
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 |
|
Email Connection Properties |
See Email Connection Properties, below. |
Create an Email Connection: Example Request
XML Request |
JSON Request |
---|---|
|
|
Email Connection Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
Authentication Required |
Deprecated. If |
Boolean; Valid values: true/false. Default is false. |
N |
|
Authentication |
Method of authentication. |
Valid values (case-insensitive):
|
N |
|
Is Authorized |
If |
Boolean; read only |
N |
|
Password |
If |
|
Y (if |
|
User Name |
If |
|
Y (if |
|
Description |
Description of this record. |
|
N |
|
Email Address |
If |
|
Y |
|
n/a |
Universal Controller release that the record was exported from. |
read only | N |
|
n/a | Record table information. | read only | N |
|
Incoming Mail Server (IMAP) |
If |
|
Y |
|
IMAP Port |
If |
|
Y |
|
Enable SSL |
If |
Boolean; Valid values: true/false. Default is false. |
N |
|
Enable STARTTLS |
If |
|
N |
|
Connection Name |
Name used within the Controller to identify this Email Connection. |
|
Y |
|
OAuth Client |
The OAuth client used to authorize the email connection. |
|
Y (if |
|
Member of Business Services |
Business Services that this record belongs to. <opswiseGroups> <opswiseGroup>group1</opswiseGroup> <opswiseGroup>group2</opswiseGroup> </opswiseGroups> "opswiseGroups": ["group1","group2"] |
|
N |
|
Outgoing Mail Server (SMTP) |
If |
|
Y |
|
SMTP Port |
If |
|
Y |
|
Enable SSL |
If |
Boolean; Valid values: true/false. Default is false. |
N |
|
Enable STARTTLS |
If |
|
N |
|
n/a |
System ID field in the database for this Email Connection record. |
Persisted only if retainSysIds is set to true. |
N |
|
Use for System Notifications |
If |
Boolean; Valid values: true/false. Default is false. |
Y |
|
Trash Folder |
If |
|
N |
|
Connection Type |
Type of Email Connection. Note: You cannot modify the type after the Email Connection has been created. |
Valid Values:
Default is Outgoing (1) |
Y |
Delete an Email Connection
|
Description |
---|---|
URI |
http://host_name/uc/resources/emailconnection |
HTTP Method |
DELETE |
Description |
Deletes an Email Connection. |
URI Parameters |
See Delete an Email Connection: URI Parameters, below. |
Example URI |
http://localhost:8080/uc/resources/emailconnection?connectionname=Test4 |
Example Response |
|
Delete an Email Connection: URI Parameters
Parameter |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|
|
ID used within the Controller to identify this Email Connection. |
String; URI parameter. |
Y |
|
|
Name used within the Controller to identify this Email Connection. |
String; URI parameter. |
Y |
|
List Email Connections
|
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 |
List Email Connections: Example Response
XML Response |
JSON Response |
---|---|
|
|
Modify an Email Connection
|
Description |
---|---|
URI |
http://host_name/uc/resources/emailconnection |
HTTP Method |
PUT |
Description |
Modifies the Email Connection specified by the |
Example URI |
|
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 |
|
Example Response |
|
Modify an Email Connection: Example Request
XML Request |
JSON Request |
---|---|
|
|
Read an Email Connection
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 |
Read an Email Connection: URI Parameters
Parameter |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|
|
ID used within the Controller to identify this Email Connection. |
String; URI parameter. |
Y |
|
|
Name used within the Controller to identify this Email Connection. |
String; URI parameter. |
Y |
|
Read an Email Connection: Example Response
XML Response |
JSON Response |
---|---|
|
|