AzureOAuthSMTP Plugin

Tutorial: How to use the AzureOAuthSMTP plugin for LimeSurvey

Prerequisites

• Access LimeSurvey over HTTPS.

Instructions

Set up the OAuth 2.0 Web Application in Azure Portal

1. Go to the Azure Portal and sign in.
2. Under Azure Services, click on App Registrations
3. Click New Registration.
4. Enter a name for your web app and select Who will have access to the Application.
5. Click Register.

Configure the OAuth 2.0 Web Application

Once your web app is created, you will land on the Overview tab.

1. Focus on the Essentials section.
2. Under the section Client Credentials, click Add a certificate or a secret and add a secret.
3. Under the section Redirect URIs, click Add the Redirect URI, which you can copy it if from the plugin settings page.
4. Now you have created the application and you can copy Client ID, Client Secret and Tenant Id values to carry over to the plugin settings.

Activate the AzureOAuthSMTP plugin in LimeSurvey.

1. Go to the Plugins page in LimeSurvey and look for the AzureOAuthSMTP plugin.
2. If you can't find the AzureOAuthSMTP plugin in the list of available plugins, click the 'Scan files' button, and install the plugin first.
3. Click Activate to activate the plugin.

Configure the AzureOAuthSMTP plugin in LimeSurvey.

1. Go to the Settings page for the AzureOAuthSMTP plugin.
2. Please notice the Help section on the top.
3. Enter the Client ID, Client Secret, and Tenant ID values that you copied from Azure Portal.
4. Notice the Tenant ID usually shall be set to consumers, still that depends on the Azure Application.
5. Click Save.

Get a new OAuth token.

1. At plugin's overview page, click the Get new token link to open Azure's consent screen in a new window.
2. Follow the steps in the consent screen and check the requested permissions.
3. Once you have granted permission, you will be redirected back to LimeSurvey.

Test the AzureOAuthSMTP plugin.

1. Go to Global Settings
2. In the Email settings, select Plugin as the Email Method.
3. Scroll down and select the the Plugin that will be used for sending emails.
4. Save
5. Click Test to send a test email.

Additional notes

• If you are using a self-hosted version of LimeSurvey, you will need to configure your web server to allow HTTPS traffic.
• If you are using a cloud-hosted version of LimeSurvey, such as Limesurvey Cloud, you will not need to configure HTTPS traffic.

References

Please find below some additional documentation which could be usefull:

• General OAuth Azure Process

https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth

• Environment Setup

https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app