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.

...

	Description
URI	http://host_name/uc/resources/emailconnection
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	Status 200 /OK Successfully created the Email Connection with sysId {sysId}. Status 400 /Bad Request Create Email Connection failed. A duplicate value has been detected. Name must be unique.
Email Connection Properties	See Email Connection Properties, below.

Anchor
Create an Email Connection Example Request
Create an Email Connection Example Request
Create an Email Connection: Example Request

XML Request

JSON Request

Expand

title	XML Request

<emailConnection exportReleaseLevel="7.3.0.0" exportTable="ops_email_connection" retainSysIds="true" version="3">
    <authentication>true</authentication>
    <authenticationType>Password</authenticationType>
    <defaultUser>jane.doe@stonebranch.com</defaultUser>
    <description />
    <emailAddr>jane.doe@stonebranch.com</emailAddr>
    <imap />
    <imapPort>143</imapPort>
    <imapSsl>false</imapSsl>
    <imapStarttls>false</imapStarttls>
    <name>Email Connection 1</name>
    <oauthClient />
    <opswiseGroups/>
    <smtp>smtp.gmail.com</smtp>
    <smtpPort>465</smtpPort>
    <smtpSsl>true</smtpSsl>
    <smtpStarttls>false</smtpStarttls>
    <sysId>3b2c5049632841189888c921f9584edf</sysId>
    <systemConnection>false</systemConnection>
    <trashFolder />
    <type>Outgoing</type>
</emailConnection>

Expand

title	JSON Request

{
  "authentication" : true,
  "authenticationType" : "Password",
  "defaultUser" : "jane.doe@stonebranch.com",
  "description" : null,
  "emailAddr" : "jane.doe@stonebranch.com",
  "exportReleaseLevel" : "7.3.0.0",
  "exportTable" : "ops_email_connection",
  "imap" : null,
  "imapPort" : 143,
  "imapSsl" : false,
  "imapStarttls" : false,
  "name" : "Email Connection 1",
  "oauthClient" : null,
  "opswiseGroups" : [ ],
  "retainSysIds" : true,
  "smtp" : "smtp.gmail.com",
  "smtpPort" : 465,
  "smtpSsl" : true,
  "smtpStarttls" : false,
  "sysId" : "3b2c5049632841189888c921f9584edf",
  "systemConnection" : false,
  "trashFolder" : null,
  "type" : "Outgoing",
  "version" : 3
}

...

	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	Status 200 /OK Email Connection deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify `connectionname` and `connectionid` at the same time. Status 404 /Not Found An Email Connection with {name/id} "test" does not exist.

...

	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	See Email Connection Properties.

...

XML Response

JSON Response

Expand

title	XML Request

<emailConnection exportReleaseLevel="7.3.0.0" exportTable="ops_email_connection" retainSysIds="true" version="3">
    <authentication>true</authentication>
    <authenticationType>Password</authenticationType>
    <authorized>false</authorized>
    <defaultUser>jane.doe@stonebranch.com</defaultUser>
    <description />
    <emailAddr>jane.doe@stonebranch.com</emailAddr>
    <imap />
    <imapPort>143</imapPort>
    <imapSsl>false</imapSsl>
    <imapStarttls>false</imapStarttls>
    <name>Email Connection 1</name>
    <oauthClient />
    <opswiseGroups/>
    <smtp>smtp.gmail.com</smtp>
    <smtpPort>465</smtpPort>
    <smtpSsl>true</smtpSsl>
    <smtpStarttls>false</smtpStarttls>
    <sysId>3b2c5049632841189888c921f9584edf</sysId>
    <systemConnection>false</systemConnection>
    <trashFolder />
    <type>Outgoing</type>
</emailConnection>

Expand

title	JSON Request

Expand

title	JSON Request

{
  "authentication" : true,
  "authenticationType" : "Password",
  "authorized" : false,
  "defaultUser" : "jane.doe@stonebranch.com",
  "description" : null,
  "emailAddr" : "jane.doe@stonebranch.com",
  "exportReleaseLevel" : "7.3.0.0",
  "exportTable" : "ops_email_connection",
  "imap" : null,
  "imapPort" : 143,
  "imapSsl" : false,
  "imapStarttls" : false,
  "name" : "Email Connection 1",
  "oauthClient" : null,
  "opswiseGroups" : [ ],
  "retainSysIds" : true,
  "smtp" : "smtp.gmail.com",
  "smtpPort" : 465,
  "smtpSsl" : true,
  "smtpStarttls" : false,
  "sysId" : "3b2c5049632841189888c921f9584edf",
  "systemConnection" : false,
  "trashFolder" : null,
  "type" : "Outgoing",
  "version" : 3
}

...

	Description
URI	http://host_name/uc/resources/emailconnection
HTTP Method	PUT
Description	Modifies the Email Connection specified by the `sysId`.
Example URI	http://localhost:8080/uc/resources/emailconnection
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	See Email Connection Properties.
Example Response	Status 200 /OK Successfully updated the Email Connection with sysId <sysId> to version <version>.

...

XML Request

JSON Request

Expand

title	XML Request

<emailConnection>
    <authentication>true</authentication>
    <defaultPwd>abc1</defaultPwd>
    <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

title	JSON Request

{
    "authentication": true,
    "defaultPwd": "abc1",
    "defaultUser": "user1",
    "description": "description",
    "emailAddr": "jane.doe@stonebranch.com",
    "imap": null,
    "imapPort": null,
    "imapSsl": true,
    "imapStarttls": null,
    "name": "Email Connection 1",
    "opswiseGroups": null,
    "smtp": "server1",
    "smtpPort": 4567,
    "smtpSsl": true,
    "smtpStarttls": false,
    "systemConnection": true,
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "trashFolder": null,
    "type": "Outgoing"
}

Anchor
Read an Email Connection
Read an Email Connection
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	See Email Connection Properties.

...

XML Response

JSON Response

Expand

title	XML Request

<emailConnection exportReleaseLevel="7.3.0.0" exportTable="ops_email_connection" retainSysIds="true" version="3">
    <authentication>true</authentication>
    <authenticationType>Password</authenticationType>
    <authorized>false</authorized>
    <defaultUser>jane.doe@stonebranch.com</defaultUser>
    <description />
    <emailAddr>jane.doe@stonebranch.com</emailAddr>
    <imap />
    <imapPort>143</imapPort>
    <imapSsl>false</imapSsl>
    <imapStarttls>false</imapStarttls>
    <name>Email Connection 1</name>
    <oauthClient />
    <opswiseGroups/>
    <smtp>smtp.gmail.com</smtp>
    <smtpPort>465</smtpPort>
    <smtpSsl>true</smtpSsl>
    <smtpStarttls>false</smtpStarttls>
    <sysId>3b2c5049632841189888c921f9584edf</sysId>
    <systemConnection>false</systemConnection>
    <trashFolder />
    <type>Outgoing</type>
</emailConnection>

Expand

title	JSON Request

{
  "authentication" : true,
  "authenticationType" : "Password",
  "authorized" : false,
  "defaultUser" : "jane.doe@stonebranch.com",
  "description" : null,
  "emailAddr" : "jane.doe@stonebranch.com",
  "exportReleaseLevel" : "7.3.0.0",
  "exportTable" : "ops_email_connection",
  "imap" : null,
  "imapPort" : 143,
  "imapSsl" : false,
  "imapStarttls" : false,
  "name" : "Email Connection 1",
  "oauthClient" : null,
  "opswiseGroups" : [ ],
  "retainSysIds" : true,
  "smtp" : "smtp.gmail.com",
  "smtpPort" : 465,
  "smtpSsl" : true,
  "smtpStarttls" : false,
  "sysId" : "3b2c5049632841189888c921f9584edf",
  "systemConnection" : false,
  "trashFolder" : null,
  "type" : "Outgoing",
  "version" : 3
}

...

Versions Compared

Old Version 17

New Version Current

Key

Anchor
Create an Email Connection Example Request
Create an Email Connection Example Request
Create an Email Connection: Example Request

Anchor
Read an Email Connection
Read an Email Connection
Read an Email Connection

Page Comparison

Versions Compared

Old Version 17

New Version Current

Key

AnchorCreate an Email Connection Example RequestCreate an Email Connection Example RequestCreate an Email Connection: Example Request

AnchorRead an Email ConnectionRead an Email ConnectionRead an Email Connection

Anchor
Create an Email Connection Example Request
Create an Email Connection Example Request
Create an Email Connection: Example Request

Anchor
Read an Email Connection
Read an Email Connection
Read an Email Connection