...
Formatting specifications for each web service, including details about property requirements, are provided.
Anchor | ||||
---|---|---|---|---|
|
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. |
Anchor | ||||
---|---|---|---|---|
|
Create an Email Connection: Example Request
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
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 | |||||||||||
authorized | Is Authorized | If | Boolean; read only | N | |||||||||||
| Password | If | Y (if | ||||||||||||
| User Name | If | Y (if | ||||||||||||
description | Description | Description of this record. | N | ||||||||||||
emailAddr | Email Address | If | Y | ||||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | |||||||||||
exportTable | n/a | Record table information. | read only | N | |||||||||||
imap | Incoming Mail Server (IMAP) | If | Y | ||||||||||||
imapPort | IMAP Port | If | Y | ||||||||||||
imapSsl | Enable SSL | If | Boolean; Valid values: true/false. Default is false. | N | |||||||||||
imapStarttls | Enable STARTTLS | If | N | ||||||||||||
name | 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 | ||||||||||||
opswiseGroups | Member of Business Services | Business Services that this record belongs to.
| N | ||||||||||||
smtp | Outgoing Mail Server (SMTP) | If | Y | ||||||||||||
smtpPort | SMTP Port | If | Y | ||||||||||||
smtpSsl | Enable SSL | If | Boolean; Valid values: true/false. Default is false. | N | |||||||||||
smtpStarttls | Enable STARTTLS | If | N | ||||||||||||
sysId | n/a | System ID field in the database for this Email Connection record. | Persisted only if retainSysIds is set to true. | N | |||||||||||
systemConnection | Use for System Notifications | If | Boolean; Valid values: true/false. Default is false. | Y | |||||||||||
trashFolder | Trash Folder | If | N | ||||||||||||
type | Connection Type | Type of Email Connection.
| Valid Values:
Default is Outgoing (1) | Y |
Anchor | ||||
---|---|---|---|---|
|
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 |
|
Anchor | ||||
---|---|---|---|---|
|
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 |
|
Anchor | ||||
---|---|---|---|---|
|
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 |
Anchor | ||||
---|---|---|---|---|
|
List Email Connections: Example Response
XML Response | JSON Response | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
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 |
|
Anchor | ||||
---|---|---|---|---|
|
Modify an Email Connection: Example Request
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
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 |
Anchor | ||||
---|---|---|---|---|
|
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 |
|
Anchor | ||||
---|---|---|---|---|
|
Read an Email Connection: Example Response
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...