Configuring Email Settings

An on-premise Advance instance sends email, for example password reset and user activation emails, through an SMTP server that you configure in the root application. The settings apply to the whole instance, so all tenancies share them. Changes take effect the next time Advance sends an email; you do not need to restart Advance.

If Email is Off, Advance does not send any email.

Prerequisites

  • You must be a Root Administrator.
  • To use XOAuth 2.0, you must have registered an application in your Microsoft Entra ID tenant, and given it permission to send email as the mailbox that Advance will use. See Microsoft's instructions in Authenticate an IMAP, POP or SMTP connection using OAuth.

To configure Basic authentication

Microsoft is retiring Basic authentication for SMTP AUTH in Exchange Online (Office 365). If your instance sends email through Office 365, configure XOAuth 2.0 authentication instead of Basic authentication. For Microsoft's current dates, see Updated Exchange Online SMTP AUTH Basic Authentication Deprecation Timeline.

  1. Log in to the Advance root application.
  2. In the navigation bar, click Settings, and then click Email.
  3. Switch Email to On.
  4. Set the connection type to Basic.
  5. Enter the details of your SMTP server:
    • Server address and Port - the domain name or IP address and the port number of your SMTP server.
    • Username - the username used to connect to your SMTP server.
    • Password - the password for that username. Advance stores the password encrypted.
    • SSL/TLS - whether to encrypt the connection. This is on by default. Your SMTP server must support it.
  6. Click Save.

Advance saves the settings and displays a confirmation. If a value is missing or invalid, for example a port number that is out of range, Advance does not save the settings and displays a message under the field to explain the problem.

To configure XOAuth 2.0 authentication

  1. Log in to the Advance root application.
  2. In the navigation bar, click Settings, and then click Email.
  3. Switch Email to On.
  4. Set the connection type to XOAuth 2.0.
  5. Enter the details of your SMTP server and your Microsoft Entra ID application:
    • Server address and Port - the domain name or IP address and the port number of your SMTP server.
    • Tenant ID - the Directory (tenant) ID of your Microsoft Entra ID tenant.
    • Client ID - the Application (client) ID of your registered application.
    • Client secret - the value of a client secret for your registered application. Advance stores the client secret encrypted.
    • Mailbox address - the email address of the mailbox that Advance sends email as.
  6. Click Save.

In the Microsoft Entra admin center, the Overview page of your app registration shows the Directory (tenant) ID and the Application (client) ID. You create a client secret under Certificates & secrets. Copy the secret's value when you create it, because Microsoft does not show it again.

Advance obtains an access token from Microsoft automatically, reuses it until it expires, and then requests a new one. If Microsoft rejects the details you saved, for example because the client secret is not valid or the application does not have permission, Advance cannot send email.

If you switch the connection type, Advance shows only the fields for the type you select, and only those fields are required.

To send a test email

  1. In Settings > Email, enter the email settings you want to test. You do not need to save them first. Other email that Advance sends continues to use the settings you last saved.
  2. Enter the email address to receive the test email.
  3. Click Send test email.

Advance sends a test email using the same connection that Advance uses for all other email, and confirms that it attempted to send the email. The confirmation does not guarantee delivery, so check that the email arrives in the recipient's inbox. If your server rejects the authentication details, Advance displays an error that says authentication failed.

To turn email off

  1. In Settings > Email, switch Email to Off.
  2. Click Save.

Advance saves the setting as Off, and does not send any email until you switch it on again.

Email settings after upgrading

When you upgrade to Advance 1.46 or later, the installer copies your existing SMTP settings into Settings > Email. After the upgrade, you change these settings only in the root application.

  • If you had configured an SMTP server host address, Email is On with the Basic connection type. Advance copies your port (25 if you had not set one), username, password, and SSL/TLS setting (off if you had not set one). Your username and password can be blank if your mail relay does not require credentials.
  • If you had not configured a host address, Email is Off, and Advance sends no email until you configure it.

Later upgrades do not change your Email settings.