Versions Compared

Old Version 4

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 5

changes.mady.by.user Stonebranch

Saved on

Key

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

...

XML Request

JSON Request

Expand
titleXML Request
<emailConnection exportReleaseLevel="7.3.0.0" exportTable="ops_email_connection" retainSysIds="true" version="3">
    <authentication>true</authentication>
    <authenticationType>Password</authenticationType>
    <defaultPwd>abc1<authorized>false</defaultPwdauthorized>
    <defaultUser>user1<>jane.doe@stonebranch.com</defaultUser>
    <description>description< /description>
    <emailAddr>jane.doe@stonebranch.com</emailAddr>
    <imap />
    <imapPort >143</imapPort>
    <imapSsl>true<>false</imapSsl>
    <imapStarttls>false</imapStarttls>
    <name>Email Connection 1</name>
    <opswiseGroupsoauthClient />
    <smtp>server1<opswiseGroups/smtp>
    <smtpPort>4567<smtp>smtp.gmail.com</smtp>
    <smtpPort>465</smtpPort>
    <smtpSsl>true</smtpSsl>
    <smtpStarttls>false</smtpStarttls>
    <sysId>62701879a6264107bb757a952bcc65cc<>3b2c5049632841189888c921f9584edf</sysId>sysId>
    <systemConnection>true<>false</systemConnection>
    <trashFolder />
    <type>Outgoing</type>
</emailConnection>
Expand
titleJSON Request
{
    "authentication" : true,
  "authenticationType" : "defaultPwdPassword":,
  "abc1authorized", : false,
  "defaultUser" : "user1jane.doe@stonebranch.com",
    "description" : "description"null,
    "emailAddr" : "jane.doe@stonebranch.com",
    "imapexportReleaseLevel" : null,
    "imapPort""7.3.0.0",
  "exportTable" : "ops_email_connection",
  "imap" : 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,
    "systemConnection": true,

   "sysId" : "62701879a6264107bb757a952bcc65cc3b2c5049632841189888c921f9584edf",
  "systemConnection" : false,
  "trashFolder" : null,
 
  "type" : "Outgoing",
  "version" : 3
}v

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

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 authentication = Password; 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

Anchor
defaultUser - Email
defaultUser - Email
defaultUser

User Name

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


Panel


 
JSON


Panel


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:



Default is Outgoing (1)

Y

...