...
Universal Controller supports the following RESTful-based web services for Email Connection operations, which are listed alphabetically on this page.
Formatting specifications for each web service, including details about property requirements, are provided.
...
Anchor |
---|
| Create an Email Connection Example Request |
---|
| Create an Email Connection Example Request |
---|
|
Create an Email Connection: Example Request
XML Request | JSON Request |
---|
|
Expand |
---|
| {
"authentication" : true,
" defaultPwdauthenticationType" : " abc1Password",
"defaultUser" : " user1jane.doe@stonebranch.com",
"description" : "description"null,
"emailAddr" : "jane.doe@stonebranch.com",
" imapexportReleaseLevel" : null,
"7.3.0.0",
"exportTable" : "ops_email_connection",
" imapPortimap" : null,
"imapPort" : 143,
"imapSsl" : truefalse,
"imapStarttls" : nullfalse,
"name" : "Email Connection 1",
"oauthClient" : null,
"opswiseGroups" : [ null],
"retainSysIds" : true,
"smtp" : " server1smtp.gmail.com",
"smtpPort" : 4567465,
"smtpSsl" : true,
"smtpStarttls" : false,
"sysId" : " systemConnection3b2c5049632841189888c921f9584edf" : true,
" sysIdsystemConnection" : "62701879a6264107bb757a952bcc65cc"false,
"trashFolder" : null,
"type" : "Outgoing",
"version" : 3
}
|
|
Anchor |
---|
| Email Connection Properties |
---|
| Email Connection Properties |
---|
|
Email Connection Properties
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 |
|
defaultPwd | authenticationType - Email |
---|
|
|
defaultPwd | authenticationType - Email |
---|
|
|
defaultPwd
Password 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 If authentication = true; 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 | 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 only | N |
Anchor |
---|
| exportTable - Email |
---|
| exportTable - Email |
---|
|
exportTable | n/a | Record table information. | read only | N |
| 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 |
| Connection Name | Name used within the Controller to identify this Email Connection. |
| Y |
|
opswiseGroups opswiseGroups opswiseGroups
Member of Business Services | Business Services | 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 |
---|
<opswiseGroups>
<opswiseGroup>group1</opswiseGroup>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups> |
JSON
|
N | "opswiseGroups": ["group1","group2"] |
|
| N |
| 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 |
| Connection Type | Type of Email Connection.
Note |
---|
| You cannot modify the type after the Email Connection has been created. |
| Valid Values: - As String = Outgoing, As Value = 1
- As String = Incoming, As Value = 2
Default is Outgoing (1) | Y |
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
XML Response | JSON Response |
---|
Expand |
---|
| <emailConnections>
<emailConnection exportReleaseLevel="7.2.0.0" exportTable="ops_email_connection" version="7">
<authentication>true</authentication>
<defaultUser>user1</defaultUser>
<description>description</description>
<emailAddr>jane.doe@stonebranch.com</emailAddr>
<imap />
<imapPort />
<imapSsl>true</imapSsl>
<imapStarttls>false</imapStarttls>
<name>Email Connection 1</name>
<opswiseGroups />
<smtp>server1</smtp>
<smtpPort>4567</smtpPort>
<smtpSsl>true</smtpSsl>
<smtpStarttls>false</smtpStarttls>
<sysId>62701879a6264107bb757a952bcc65cc</sysId>
<systemConnection>true</systemConnection>
<trashFolder />
<type>Outgoing</type>
</emailConnection>
<emailConnection exportReleaseLevel="7.2.0.0" exportTable="ops_email_connection" version="2">
<authentication>true</authentication>
<defaultUser>user2</defaultUser>
<description>description</description>
<emailAddr>john.doe@stonebranch.com</emailAddr>
<imap />
<imapPort />
<imapSsl>true</imapSsl>
<imapStarttls>false</imapStarttls>
<name>Email Connection 2</name>
<opswiseGroups />
<smtp>server2</smtp>
<smtpPort>4568</smtpPort>
<smtpSsl>true</smtpSsl>
<smtpStarttls>false</smtpStarttls>
<sysId>62701879a6264107bb757a952bcc65cc</sysId>
<systemConnection>true</systemConnection>
<trashFolder />
<type>Outgoing</type | <emailConnection exportReleaseLevel="7.3.0.0" exportTable="ops_email_connection" retainSysIds="true" version="3">
<authentication>true</authentication>
< /emailConnection>
<emailConnections>
| Expand |
---|
| {authenticationType>Password</authenticationType>
"authentication": true,<authorized>false</authorized>
"defaultUser": "user1",<defaultUser>jane.doe@stonebranch.com</defaultUser>
"<description ": "description", />
"emailAddr": "jane<emailAddr>jane.doe@stonebranch. com", com</emailAddr>
<imap />
"exportReleaseLevel": "7.2.0.0", <imapPort>143</imapPort>
"exportTable": "ops_email_connection", <imapSsl>false</imapSsl>
"imap": null,
<imapStarttls>false</imapStarttls>
"imapPort": null,
<name>Email Connection 1</name>
"imapSsl": true,
<oauthClient />
"imapStarttls": null, <opswiseGroups/>
"name": "Email Connection 1",
"opswiseGroups": null,
<smtp>smtp.gmail.com</smtp>
<smtpPort>465</smtpPort>
<smtpSsl>true</smtpSsl>
"retainSysIds": true, <smtpStarttls>false</smtpStarttls>
"smtp": "server1",<sysId>3b2c5049632841189888c921f9584edf</sysId>
"smtpPort": 4567,<systemConnection>false</systemConnection>
"smtpSsl": true,<trashFolder />
"smtpStarttls": false,<type>Outgoing</type>
</emailConnection> |
|
Expand |
---|
|
systemConnection
sysId62701879a6264107bb757a952bcc65cc
trashFolder:null,
"type": "Outgoing"
}{ "authentication": true, user2jane.doe@stonebranch.com",
|
"description" johndoe@stonebranch "exportReleaseLevel" : "7.
| 2
"exportTable" : "ops_email_connection",
|
null true null null server2 4568 systemConnectiontrue"3b2c5049632841189888c921f9584edf",
|
sysId"62701879a6264107bb757a952bcc65cc" "
|
|
Anchor |
---|
| Modify an Email Connection |
---|
| Modify an Email Connection |
---|
|
Modify an Email Connection
...
Anchor |
---|
| Read an Email Connection URI Parameters |
---|
| Read an Email Connection URI Parameters |
---|
|
Read an Email Connection: URI Parameters
...
XML Response | JSON Response |
---|
|
Expand |
---|
title | JSON ResponseRequest |
---|
| {
"authentication" : true,
"authenticationType" : " defaultUserPassword" :,
" user1authorized" : false,
"defaultUser" : " description":jane.doe@stonebranch.com",
"description" , : null,
"emailAddr" : "jane.doe@stonebranch.com",
"exportReleaseLevel" : "7. 23.0.0",
"exportTable" : "ops_email_connection",
"imap" : null,
"imapPort" : null143,
"imapSsl" : truefalse,
"imapStarttls" : nullfalse,
"name" : "Email Connection 1",
"oauthClient" : null,
"opswiseGroups" : [ null],
"retainSysIds" : true,
"smtp" : " server1smtp.gmail.com",
"smtpPort" : 4567465,
"smtpSsl" : true,
"smtpStarttls" : false,
"sysId" : " systemConnection3b2c5049632841189888c921f9584edf" : true,
" sysIdsystemConnection" : "62701879a6264107bb757a952bcc65cc"false,
"trashFolder" : null,
"type" : "Outgoing",
"version" : 13
}
|
|