SMTP settings

Simple Mail Transfer Protocol (SMTP) settings are your outgoing email server settings. This particular protocol only works for outgoing messages and is used with various portal features that send emails from the portal, such as  sending records by email, password recovery, and email notifications about changes on records a member is subscribed to.

To configure SMTP settings

  1. In the backoffice, go to Media > Site settings.
  2. On the General tab, under SMTP settings, select Add content to create a new set of settings, or edit existing settings.
  3. Select the authentication method:
    1. Legacy password-based authentication
    2. OAuth 2.0 authentication (recommended)
  4. Fill in the fields as described below.
    1. If you selected Legacy password-based authentication:
      1. Enabled - Specifies whether this set of SMTP settings will be enabled. If you have multiple SMTP setting sets enabled, the first set of settings will be used.
      2. Email category - Specifies the category of emails that this SMTP setting set will be used for.
        The first found enabled SMTP setting set for each email category will be used. We recommend configuring a separate set of settings for each category. If the portal cannot find separate settings for the Notifications or Administration category, the General category will be used.
        1. Administration: For administration emails only.
        2. General: For all portal emails except administration- and notification-related emails.
        3. Notifications: For email notifications only.
      3. Network host - Specifies the actual outgoing email server hostname that is an individual one for each provider. For example, smtp-mail.outlook.com; smtp.gmail.com.
      4. Username - Specifies the email address from which emails will be sent.
      5. Email - Specifies the email address that will be used to send emails from.
      6. Password - Specifies the password of the email address specifies in the Username setting.
      7. Port - Specifies the port through which emails will be sent. Port 587 is recommended for secure connection.
      8. Enable SSL - Specifies whether the SMTP connection will be secured with SSL.
      9. Default credentials - Specifies whether the default credentials (username and password) will be used instead of the credentials specifies in this settings set.
      10. Redirect to report email - Specifies whether all emails sent by the portal will be redirected to the email(s) specifies in the Report emails setting. Redirecting emails is useful for testing purposes.
      11. Report emails - Specifies email(s) to which all emails sent by the portal will be redirected if the Redirect to report emails setting is enabled. You can set up multiple report emails.
        1. Email – Specifies the email to which all emails sent by the portal will be redirected if the Redirect to report emails setting is enabled. 
        2. Enabled – Specifies whether this report is enabled. Use this switch to temporarily disable a report email without having to remove the settings.
    2. If you selected OAuth 2.0 authentication
      1. Enabled - Specifies whether this set of SMTP settings will be enabled. If you have multiple SMTP setting sets enabled, the first set of settings will be used.
      2. Email category - Specifies the category of emails that this SMTP setting set will be used for.
        The first found enabled SMTP setting set for each email category will be used. We recommend configuring a separate set of settings for each category. If the portal cannot find separate settings for the Notifications or Administration category, the General category will be used.
        1. Administration: For administration emails only.
        2. General: For all portal emails except administration- and notification-related emails.
        3. Notifications: For email notifications only.
      3. Identity provider - Specifies the service that provides OAuth 2.0 authentication services. Select Google or Microsoft Entra ID. A custom identity provider can be added as part of customization.
      4. Network host - Specifies the actual outgoing email server hostname that is an individual one for each provider. For example, smtp-mail.outlook.com; smtp.gmail.com.
      5. Token issue method - Specifies the method that defines the flow of issuing a token by the identity provider: authorization code, client issue, or password.
      6. Username - Specifies the email address from which emails will be sent.
      7. Email - Specifies the email address that will be used to send emails from.
      8. Password - Specifies the password of the email address specifies in the Username setting. With OAuth 2.0 authentication, this setting is filled in only when the Token issue method setting is set to Password.
      9. Port - Specifies the port through which emails will be sent. Port 587 is recommended for secure connection.
      10. Default credentials - Specifies whether the default credentials (username and password) will be used instead of the credentials specifies in this settings set.
      11. Redirect to report email - Specifies whether all emails sent by the portal will be redirected to the email(s) specifies in the Report emails setting. Redirecting emails is useful for testing purposes.
      12. Report emails - Specifies email(s) to which all emails sent by the portal will be redirected if the Redirect to report emails setting is enabled. You can set up multiple report emails.
        1. Email – Specifies the email to which all emails sent by the portal will be redirected if the Redirect to report emails setting is enabled. 
        2. Enabled – Specifies whether this report is enabled. Use this switch to temporarily disable a report email without having to remove the settings.
      13. Client ID - Specifies the client ID that was obtained for this portal application on the identity provider site.
      14. Client secret - Specifies the client secret that was obtained for this portal application on the identity provider site.
      15. Refresh token - Specifies the refresh token. Refresh tokens are issued to the client by the authorization server and are used to obtain a new access token when the current access token becomes invalid or expires, or to obtain additional access tokens with identical or narrower scope (access tokens may have a shorter lifetime and fewer permissions than authorized by the resource owner).
        This setting is used when the Token issue method setting is set to Authorization code. To get a refresh token from the identity provider, after you have set up the Client ID, Client secret and (in case of Microsoft Entra ID), the Tenant ID settings, select the Authorize action and authorize a Microsoft/Google account with the corresponding identity provider. The account must have the appropriate permissions to send emails. Once you sign in, follow the instructions on screen and, if asked, grant permissions that the identity provider requests. As a result, the refresh token is issued by the identity provider and automatically filled in this setting.
         
      16. Provider-specific settings - Specifies the additional settings that may be required for the chosen identity provider.
        1. External service name - Specifies the name of the setting for which the value must be specified in the Value setting.
        2. Value - Specifies the value for the selected setting.
        3. Comment - Specifies a description of the external service. You can use this field to add a note about the setting if necessary.

            Note

          In provider-specific settings, you need to configure the following:

          For the Microsoft Entra ID identity provider:

          1. Tenant ID (required)
          2. Scope (optional) - defines the permissions (what can be accessed)

          For the Google provider:

          1. Scope (optional) 

          Also, for some identity providers, you may need to configure Access token URL template (not necessary for Microsoft Entra ID or Google). This URL template may include variables, such as the variable for tenant ID. For example:
          https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token

  5. Optionally, create an alternative set of of SMTP settings. Only one set of SMTP settings can be enabled at a time; if you have multiple SMTP setting sets enabled, the first set of settings will be used. However, you can have separate settings for each email category.
  6. In the backoffice, select Settings > More Reload Application for changes in the SMTP settings to take effect.