Versions Compared

Key

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

...

...

Step 1

From the Agents & Connections navigation pane, select System > Connections > Email Connections. The Email Connections list displays.
 
Below the list, Email Connection Details for a new Email Connection displays.
 

Step 2

Enter / select Details for a new Email Connection, using the field descriptions below as a guide.

  • Required fields display an asterisk ( * ) after the field name.
  • Default values for fields, if available, display automatically.

To display more of the Details fields on the screen, you can either:

  • Use the scroll bar.
  • Temporarily hide the list above the Details.
  • Click the  button above the list to display a pop-up version of the Details.

Step 3

Click a  button. The Email Connection is added to the database, and all buttons and tabs in the Email Connection Details are enabled.

...

Field Name

Description

Details

This section contains detailed information about the Email Connection.

Name

Include Page
IL:Connection Name
IL:Connection Name

Version

System-supplied; version number of the current record, which is incremented by the Controller very time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning.

Description

Include Page
IL:Summary
IL:Summary

Member of Business Services

Include Page
IL:Member of Business Services
IL:Member of Business Services

Anchor
Type
Type
Type

Include Page
IL:Type of Email Connection
IL:Type of Email Connection

Outgoing Mail Server (SMTP)

Include Page
IL:Outgoing Mail Server - 6.4.2.0
IL:Outgoing Mail Server - 6.4.2.0

SMTP Port

Include Page
IL:SMTP Port - 6.4.2.0
IL:SMTP Port - 6.4.2.0

Incoming Mail Server (IMAP)

Include Page
IL:Incoming Mail Server - 6.4.2.0
IL:Incoming Mail Server - 6.4.2.0

IMAP Port

Include Page
IL:IMAP Port - 6.4.2.0
IL:IMAP Port - 6.4.2.0

Enable SSL

Enables SSL/TLS connectivity for your server.

Enable STARTTLS

Enables the use of the STARTTLS command (if supported by the server) 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. )

Email Address

Include Page
IL:Email Address - 6.4.2.0
IL:Email Address - 6.4.2.0

Warning
titleWarning

If the selected sender email address is invalid, or becomes invalid at any time after you create an Email Connection, all Email Notifications that specify that Email Connection will fail, but no warning will be issued. You must click the Test Connection button to test the Email Connection, which will generate an error message in the Console.


Anchor
Authentication Required
Authentication Required
Authentication 

Specifies method of authentication.

  • If Type is Outgoing; – None – 
  • Password
  • OAuth 2.0

Anchor
User Name
User Name
User Name

If Type is Outgoing and Authentication is Password or OAuth 2.0 or Type is Incoming and Authentication is OAuth 2.0.; user name that the Controller will use to connect to the server.

Anchor
Password
Password
Password

If Type is Outgoing and Authentication is Password; password that the Controller will use to connect to the server.
 
(This field is cleared if the Email Connection is copied.)

OAuth Client

If Authentication is OAuth 2.0, the OAuth Client used to authorize the email connection. 

Tip

Click the details icon next to the OAuth Client field to create a new OAuth Client or view a selected OAuth Client's definition. 


Anchor
Use for System Notifications
Use for System Notifications
Use for System Notifications

If Type is Outgoing; Indicates whether or not this Email Connection is to be used for system notifications.
 
(This field is set to false if the Email Connection is copied.)
 

Note
titleNote

Only one Email Connection can be used for system notifications. If this field is checked in an Email Connection Details, it will appear unchecked on all other Email Connection Details. If you then check this field in another Email Connection Details, it automatically will be unchecked from the Details in which it had been checked.


Anchor
Trash Folder
Trash Folder
Trash Folder

If Type is Incoming; Folder to use for deleted emails.

Metadata

This section contains Metadata information about this record.

UUID

Universally Unique Identifier of this record.

Updated By

Name of the user that last updated this record.

Updated

Date and time that this record was last updated.

Created By

Name of the user that created this record.

Created

Date and time that this record was created.

Buttons

This section identifies the buttons displayed above and below the Email Connection Details that let you perform various actions.

Save

Saves a new Email Connection record in the Controller database.

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Save & View

Saves a new record in the Controller database and continues to display that record.

New

Displays empty (except for default values) Details for creating a new record.

Update

Include Page
IL:Update button
IL:Update button

Anchor
Test Connection
Test Connection
Test Connection

Include Page
IL:Test Connection button - Email Connection - 6.7.0.0
IL:Test Connection button - Email Connection - 6.7.0.0

Note

Test Connection dialog will only show Credentials field if Authentication is Password. 


Authorize 

After saving the record to the database, click Authorize to authorize the connection.

The Authorize button will change to Reauthorize once the Email Connection has been authorized. Reauthorize allows you to renew your consent if the access token is invalid or it has expired and cannot be refreshed.

Note

The Authorize button will only be shown if Authentication is OAuth 2.0. Email Connections using OAuth 2.0 authentication need to be authorized before they can be used.


Copy

Creates a copy of this Email Connection, which you are prompted to rename.

Delete

Include Page
IL:Delete button
IL:Delete button

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this Email Connection.

Tabs

This section identifies the tabs across the top of the Email Connection Details that provide access to additional information about the Email Connection.

Note

For an Agent-Only installation of Universal Controller, the Email Templates and Tasks tabs do not display.


Email Templates

Include Page
IL:Email Templates tab
IL:Email Templates tab

Tasks

Include Page
IL:Email Tasks tab - 6.4.2
IL:Email Tasks tab - 6.4.2

Anchor
VersionVersionsVersion
Versions
Versions

Include Page
IL:Versions tab
IL:Versions tab

...