Configure Mail Server Settings
Important Note: This article is for the Org Administrator in particular. The actions discussed in the article are not available to general users.
Overview
You can use the mail server settings in this article to manually set up your email to send and receive an email with an iCloud email account. ARM requires mail server settings to send the ARM notification emails for events like build failures, build successes, deployment failures, merge reports, etc.
Begin the process by hovering your mouse over the Admin
module and selecting the option: Notifications
.
You’ll then be presented with a screen divided into Mail Settings
, Send a test email
, Restricted Emails
, and Teams/Slack Settings
sections.
Mail Settings
To set up a mail client, it’s necessary to configure the server to take care of your email delivery. And here’s the standard procedure for mail configuration and adding the correct parameters in the Mail Settings
section:
Fill in the required details as listed below (mandatory fields are marked with an asterisk (*) mark.
Host Name:
Your incoming mail server name. Ex- smtp.office365.comPort:
The port number your incoming mail server uses. Ex- Port 25User Name:
The email address you want to set up. Ex- yourusername@autorabit.comPassword:
The password associated with your email account.Protocol:
The protocol to manage the transmission and outgoing mail over the internet. If your email is encrypted using SSL, select theUse SSL/TLS if available
checkbox.Email From:
Enter the email addresses you want to receive notifications while configuring the mail server.Select the
Email Notifications
checkbox to receive notification alerts.Custom Email Template:
ARM has its default email template styles, but you can also create your own. Enable theCustom Email Template
field and add your logo at the top or bottom of the page. You can add footer text too. Once you're happy with your template, save it.You can use the
Reset
button to clear all the data in theMail Settings
section and again fill in the fields.
How to reset your Mail preferences?You won't be able to switch back to the default ARM mail preferences once you have configured your email template. If you want to switch back to the default email style, please email us at support@autorabit.com, and we can do it for you.
Send a Test Mail
Before you use your customized email style, you can preview it once to make sure everything is showing correctly. Enter your email address in the Recipient
field and click on the Test
button to receive a test mail notification.
Restricted Emails
This section helps ensure that ARM-related emails are not sent to deactivated users who are no longer with the organization. Users in this list will not receive ANY emails, including deactivation, forgotten password, reset the password, jobs executed in the application, etc.
The email address of a user who has been deactivated by an admin is immediately added to this list. If an inactive user is reactivated, the email address is deleted from this list. Enter the email address(es) for the user(s) to be added to the restricted list manually. The ’x' icon next to each user’s email address allows the admin to remove any user from this list. Click Save
while adding or removing users manually.
To remove all users from the Restricted Emails
list, click Delete All
, and then click Yes
to confirm.
NoteIf you are not receiving any emails related to the application, you can contact your admin to check if you've been added to the restricted emails list. After the admin removes you from the list, you will receive any new emails from that point forward.
Teams/Slack Settings
When an event is triggered in ARM, email notifications are sent to the selected individuals. If you want to send notifications for particular events to an entire group within your organization through Teams
or Slack
, then integrate your Teams or Slack application with ARM using the respective Webhook Integration URL
. For more information on configuring a webhook on Teams
, click HERE. For Slack
, click HERE.
Select either
Teams
orSlack
as per your organization's requirements.
Enter a
Channel Name
and theWebhook Integration URL
.Click on
Test Connection
. ATest connection Successful
notification will be displayed.If the test connection fails, an error message will be displayed. Check and re-enter the correct webhook URL.
After a successful test connection, click
Save
.
Click on the
+
icon to add another channel. You can add up to 10 channels.
Click the
x
icon to delete a channel and clickYes
on the confirmation message.
Notification Configuration
This section is a guide to configuring the channels to the notification types. You can select which group(s) on Teams or Slack should be notified when a particular event is triggered.
Select the checkbox for the
Notification Type
that you want to configure.Click the
Selected Channels
field to display a list of configured channels.
Click the channel that you want to send the notification to when this event is triggered. You can select up to five channels for each notification type, meaning you can select as many channels as you have configured.
You can select multiple checkboxes for numerous notification types and select the channels to which you want to send notifications for each event.
Click
Save
. All the selectedNotification types
will be saved simultaneously.When an event is triggered in ARM, the configured channels will receive a notification. The image below is an example of what these notifications look like on Teams.
Last updated