Configure the Email Handler

Overview

Configuration

Test and Enable

Overview

Cirrus Identity provides integration with email as part of your subscription for the following functionality:

• Cirrus One-Time Code MFA
• Cirrus Proxy with Invitation Service or OrgBrandedID
• Verified email address capability of the ID Verify Form used with Account Linking

The Email Handler is the way Cirrus Identity passes email messages to a Customer's email relay for delivery. There are many reasons why it is important for emails from your institution to come through your email server, such as the reasons below:

• Delivery using an organizational email relay will allow delivery from an address associated with the organization and with the reputation of the organization – thereby avoiding classification as SPAM.
• You will be in a position to report on and diagnose end-user delivery issues.
• You are able to control and apply security controls on the mail delivery that meet the needs of the organization.

In order to configure the Email Handler, you must have an email relay accessible on the public internet that uses either username/password or ip-based authentication such as:

• Institution email relay that allow for public access with or without statically defined network rules
• Third-party email relay for external sending such as Mailgun or SendGrid 

Please note that the mail relay does not need to be the primary one for an organization. A dedicated third-party mail relay can be used for the deployment, or a shared “external” mail relay that may already exist for other marketing, outreach, or other services can be used.

Configuration

Navigate to Email Handler Configuration in the Cirrus Console

Login to the Cirrus Console and select your Organization under “My Organization”.

On the Organization page, select “Email Handler” from the left menu. 

Enter Configuration Information

The following customer provided data should be entered into the Console form:

• SMTP Host: the fully qualified domain name (FQDN) of the email relay
• SMTP Port: the TCP/IP port number at the email relay FQDN. The default port is 587 for TLS connections.
• SMTP User: the username of the authenticating account to receive the messages 
• SMTP Password: the matching secret to the SMTP User
• SMTP From: the email address where any delivery failures will be sent
• Check the box for Require StartTLS to establish a TLS connection to the mail relay at the indicated FQDN and Port.

Save the Configuration

Press the “Update Email Handler Button” to save your configuration. It will not be enabled until you enable the configuration.

Test and Enable

Test Configuration

To test if the SMTP configuration is complete, press the “Test SMTP Config” button. This will send a test message containing the configured parameters to the email address of the admin currently logged into the console. 

A notification will appear at the top of the screen letting you know the test email was sent.

Check your email for the test email, which will look similar to the example email below. 

Enable Configuration

When a configuration is complete and testing is successful, check the box for “Use My SMTP” at the top to enable it.