Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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

...

Property

UI Field Name

Description

Specifications

Required

Anchor
authentication - Email
authentication - Email
authentication

Authentication Required

If type = Outgoing; Specification for whether or not defaultUser and password are required.

Boolean; Valid values: true/false. Default is false.

N

Anchor
defaultPwd - Email
defaultPwd - Email
defaultPwd

Password

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

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


Panel
"opswiseGroups": ["group1","group2"]



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:

  • 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

...

XML Response

JSON Response


Expand
titleXML Response
<emailConnections>
    <emailConnection    <emailConnectionexportReleaseLevel="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>
<emailConnections>




Expand
titleJSON Response
{
    "authentication": true,
    "defaultUser": "user1",
    "description": "description",
    "emailAddr": "jane.doe@stonebranch.com",
     "descriptionexportReleaseLevel": "description7.2.0.0",

    "emailAddrexportTable": "jane.doe@stonebranch.comops_email_connection",

    "imap": null,
    "imapPort": null,
    "imapSsl": true,
    "imapStarttls": null,
    "name": "Email Connection 1",
    "opswiseGroups": null,
    "retainSysIds": true,
    "smtp": "server1",
    "smtpPort": 4567,
    "smtpSsl": true,
    "smtpStarttls": false,
    "systemConnection": true,
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "trashFolder": null,
    "type": "Outgoing"
}
{
    "authentication": true, 
    "defaultUser": "user2",
    "description": "description", 
    "emailAddr": "john.doe@stonebranch.com", .doe@stonebranch.com", 
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_email_connection",
    "imap": null, 
    "imapPort": null, 
    "imapSsl": true, 
    "imapStarttls": null, 
    "name": "Email Connection 1", 
    "opswiseGroups": null, 
    "retainSysIds": true, 
    "smtp": "server2", 
    "smtpPort": 4568, 
    "smtpSsl": true, 
    "smtpStarttls": false, 
    "systemConnection": true, 
    "sysId": "62701879a6264107bb757a952bcc65cc", 
    "trashFolder": null, 
    "type": "Outgoing"
}


...

XML Response

JSON Response


Expand
titleXML Response
<emailConnection exportReleaseLevel="7.2.0.0" exportTable="ops_email_connection" retainSysIds="true" version="1">
    <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>



Expand
titleJSON Response
{
    "authentication": true,
    "defaultUser": "user1",
    "description": "description",
    "emailAddr": "jane.doe@stonebranch.com",
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_email_connection",
    "imap": null,
    "imapPort": null,
    "imapSsl": true,
    "imapStarttls": null,
    "name": "Email Connection 1",
    "opswiseGroups": null,
    "retainSysIds": true,
    "smtp": "server1",
    "smtpPort": 4567,
    "smtpSsl": true,
    "smtpStarttls": false,
    "systemConnection": true,
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "trashFolder": null,
    "type": "Outgoing",
    "version": 1
}


...