Email

Avantra can send email notifications via a configured mail server. Mail servers are managed under Configuration > Integrations > Messaging Services.

Adding a mail server

To add a new mail server:

1. Navigate to Configuration > Integrations > Messaging Services.
2. Click New and select New Mail Server.
3. Add a Name for the mail server.
4. (Optional) Add a Description.
5. Select a Customer
6. Select either a SMTP or SMTPS_SECURESMTP Protocol.
7. Define the SMTP port number in the Port field.
8. Ser the TLS field to Yes to have the mail server use TLS security.
9. Select an Authentication Type.
   Depending on the selected Authentication Type, the following additional fields are shown. Avantra supports three authentication types for mail server connections:
   • Basic: username and password authentication. Suitable for internal mail servers. Major providers including Microsoft Exchange Online and Google Workspace are deprecating basic authentication; see Migrating from Basic to OAuth authentication if you are affected.
   • OAuth2 Client Credentials: OAuth 2.0 client credentials flow. Suitable for service-account-based sending via Microsoft 365 or Google Workspace.
   • OAuth2 Authorization Code: OAuth 2.0 authorization code flow. Suitable for delegated sending where a specific user identity is involved.
     OAuth2 options require an OAuth credential to be configured first under Configuration > Integrations > Credentials.
10. Click Create.

Using a mail server as a notification channel

Once a mail server is configured, add it as an output channel in your notification setup:

1. Navigate to Configuration > Notifications > Notifications [Global] > Channels > Email.
2. Fill in the required fields and click Finish.
3. In the Properties section, select the mail server from the dropdown and configure the notification recipient and alert conditions.
4. Click Save.

Migrating from Basic to OAuth authentication

Microsoft is deprecating basic authentication for Exchange Online, and Google Workspace has similarly restricted basic SMTP authentication. If you are using Avantra with either of these providers, migrate your mail server configuration to OAuth2 before basic authentication is disabled by your provider.

Before you begin

Before reconfiguring your mail server in Avantra, register an OAuth application with your mail provider and configure the resulting credential in Avantra under Configuration > Integrations > Credentials. The credential must belong to the same customer as the mail server you are updating.

Refer to your provider's documentation for OAuth app registration:

• Microsoft Exchange Online: Register an app in Azure Active Directory with the Mail.Send permission (application permission for Client Credentials flow, delegated permission for Authorization Code flow).
• Google Workspace: Register an app in Google Cloud Console with the Gmail API and the https://mail.google.com/ scope.

Updating your mail server configuration

Once your OAuth credential is configured in Avantra:

1. Navigate to Configuration > Integrations > Messaging Services.
2. Locate the mail server you wish to update and open it for editing.
3. Change the Authentication Type from Basic to either OAuth2 Client Credentials or OAuth2 Authorization Code, depending on the flow your OAuth app registration uses.
4. In the OAuth Credential field, select the credential you configured under Configuration > Integrations > Credentials. The list is filtered to show only credentials matching the selected customer and authentication flow type.
5. Click Save.

note

Basic authentication remains available at this time for backwards compatibility.

Verifying the configuration

After saving, trigger a test notification to confirm email delivery is working correctly. If delivery fails, verify the following:

• The OAuth credential is valid and has not expired.
• The OAuth app registration has the correct permissions for SMTP sending.
• The mail server Customer matches the customer the OAuth credential belongs to.
• For Microsoft Exchange Online, ensure the mailbox being used to send is covered by the app registration's permission scope.