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 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 |
| 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
JSON | Panel |
|---|
| Html bobswift |
|---|
<pre>
<opswiseGroups>
<opswiseGroup>group1</opswiseGroup>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups>
</pre> |
|
JSON
| Panel |
|---|
| Html bobswift |
|---|
<pre>
"opswiseGroups": ["group1","group2"]
</pre> |
|
|
| 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:
| Html bobswift |
|---|
<ul>
<li> As String = Outgoing, As Value = 1
<li> As String = Incoming, As Value = 2
</ul> |
Default is Outgoing (1) | Y |
