Email Notifier
The Email module allows notifications to be sent as email to the contacts assigned to the notification. Email addresses can be manually added to contact records or users can add them if you're using the Self-Management Portal.
Note: Internal and external recipients must be set up as Contacts.
Note: If you configure more than one SMTP server, by default the system uses the last one configured. However, for each notification you can select which server, or gateway, you want to use from Choose Contact Methods.
- Go to Configuration > Email
- Select New > New SMTP Server settings
-
For Name, enter a descriptive name for your SMTP server.
For example, Gmail Account or Office 365.
-
For Authentication Type, select a value as defined by your SMTP provider.
-
Enter your SMTP Server Hostname or IP Address.
Note: When using Gmail, you need to set up two-factor authentication and create an app password for your account.
- Enter your SMTP server Port. (Port 25 is a basic default port that has no SSL.)
-
For From Address, enter your SMTP email address.
Note: This email address displays to email notification recipients as the email sender.
Important: When your Authentication Type is OAuth this address must be the same as the account used to create the token.
-
(Optional) For To Address, enter an email address used to populate the To field of the email.
This field accepts only a single email address.
For example, you may want the notifications to go to an audit mailbox in addition to all associated recipients.
- For the following fields, refer to your SMTP provider setup documentation to determine what to enter in the following fields or leave them blank.
- Accepted Domains – This is typically left blank.
-
Token - This option appears when you select an Authentication Type of OAuth. You will need to select an existing Token (of type OAuth or O365) or create a new one (select Create New from the drop-down). Configuration > Integrations > Token.
See Creating an OAuth Token. When creating a O365 token, you must include a custom parameter:
scope = https://outlook.office.com/SMTP.Send offline_access
Tip: Clear your browser cache before creating the token to ensure an account from someone else is not cached and the token attempts uses that information instead.
- Username and Password – Username may or may not be the same as what you entered in the From Address field, this depends on your SMTP provider. For Gmail, your password should be the App password you created for specific use with SMTP.
- Auth Domain – This is typically left blank.
- Use SSL/TLS – Your SMTP provider determines whether you need to select this option. TLS 1.0 and higher is supported. SSL 3.0 is not supported. Transport Layer Security is the SSL security replacement. Both TLS and SSL are often both referred to as SSL.
- Leave Preference Order at zero. This functionality is for future use.
-
If your SMTP provider has a maximum number of recipients that can be included in a single email, enter that number here; otherwise, leave this field at zero.
If the notification is assigned more contacts with email addresses than the maximum designated here, Revolution batches the notification. For example, let's say the maximum recipients is 10. I've got a notification with 15 contacts assigned as recipients. Revolution sends two notifications – one with 10 email addresses and a second with 5 email addresses.
- (Optional) Enable Add Plain Text View. Email notifications are sent in HTML by default. When enabled, the notification is sent in plain text view if the mail client doesn't accept HTML. Be aware, however, that some email clients may not display the email notification correctly when the 'Add Plain Text View' functionality is enabled.
Below is the typical setup for Gmail and Office 365 business SMTP.
Field | Value |
---|---|
Name | Gmail Server |
Authentication Type | Negotiate |
Server Hostname or IP Address | smtp.gmail.com |
Port | 587 |
From Address | name@your-company.org |
Accepted Domains | blank |
Username | same as From Address = name@your-company.org |
Password | Specific App password as generated for your Gmail account. |
Auth Domain | blank |
Use SSL | checked |
Preference Order | 10 |
Max Recipients Per Message | 0 |
Add Plain Text View | unchecked |
Field | Value |
---|---|
Name | Outlook Office 365 |
Authentication Type | OAuth |
Server Hostname or IP Address | smtp.office365.com |
Port | 587 |
From Address | name@your-company.org |
Accepted Domains | blank |
Token | Complete as needed |
Preference Order | 0 |
Max Recipients Per Message | 0 |
Add Plain Text View | unchecked |
By default, Revolution limits the number of SMTP clients to 10. You can alter the Simultaneous SMTP Clients setting to a value between 1 and 20 in the Settings tab of the Email page.
If a notification has a Priority level greater than the global priority setting (Global Settings > Notification > Emergency Priority Threshold) the outgoing email will be marked as high priority. See Setting the priority The default value is 8, which means that notifications with priority level of 9 or 10 will be sent as high priority.
-
Enter email addresses for the contacts you want email notifications sent to. See Contacts.
-
Assign contacts as recipients for each notification you want sent as email and select the Email option in Choose Contact Methods. At this point you will be able to choose from any of the email gateways you create. See Choose Contact Methods.
Once you delete an Email account and there are no other Email accounts configured, Email no longer displays as a communication method for contacts when assigning them to notifications.